Struct PartitionSpec

source

pub struct PartitionSpec {
    pub num: u32,
    pub part_type: PartitionType,
    pub start_sector: Option<u64>,
    pub size_in_sectors: u64,
    pub label: Option<String>,
    pub mountpoint: Option<String>,
    pub filesystem: FilesystemType,
    pub mount_opts: Option<Vec<String>>,
    pub fs_label: Option<String>,
    pub usage: PartitionUsage,
}

Expand description

§Partition specification

Describes partitions in the partition table, and is defined in the Device Specification File. It is a list of objects in the TOML format.

It describes various aspects of a partition:

The partition type recorded in the partition table.
The size of the partition.
Where the partition starts at, in 512-byte sectors.
Whether it contains a filesystem.
Whether it has a mountpoint.
The usage of the partition, i.e. being used as a boot partition, or as a root partition.
Whether the filesystem has labels.
For GPT partition table, an optional partition label can be defined.

§Fields

§`num` - Partition number

Index of the partition in the partition table.

[[partition]]
num = 1

§`type` - Partition Type

Partition type defined in the partition table. Not to be confused by filesystem type.

Possible values are:

"efi": EFI System Partition.
"linux": Linux filesystem.
"swap": Swap partition (not allowed to be used).
"basic": Basic data partition.
"uuid": Arbitrary UUID value. An additional field uuid is required to specify the UUID value.
"byte": Arbitrary byte value. An additional field byte is required to specify the byte value.

[[partition]]
# other fields
type = "efi"
# or
type = "linux"
# or
type = "swap"
# or
type = "basic"
# Or an arbitrary UUID value
type = "uuid"
uuid = "01234567-89AB-CDEF-0123-456789ABCDEF"
# Or an arbitrary byte value
type = "byte"
byte = 0x0c

§`start_sector` - Starting position (Optional)

Defines where the partition starts in the partition table, in 512-byte sectors.

If not defined, then this partition will immidiately follow the previous partition, or starts at sector `2048`` if this is the first partition, leaving ~1MB empty space before it.

For example, your device requires a bootloader partition to be present at 32KB from start, then the value would be:

# other fields
start_sector = 64

§`size_in_sectors` - Partition size

Defines the size of the partition, in 512-byte sectors.

Use 0 if you want to fill the partition all the way to the end - only for the last partition.

For example, for a 300MiB partition, the value would be 300 * 1024 * 2 = 614400 (1 KiB = 2 sectors).

A partition can not be smaller than 512B (1 sector).

[[partition]]
# other fields ...
# 1MiB partition
size = 2048
# 1GiB partition
size = 2097152
# Max available free space
size = 0

§`label` - Partition label (GPT Only, Optional)

Name of the partition, only available on GPT partition table. Not to be confused by filesystem labels.

The partition label has a 64-characters limit.

[[partition]]
# other fields ...
label = "EFI Partition"

§`filesystem` - Filesystem contained in the partition

The filesystem to be created on the partition.

Possible values are:

ext4: Linux Extended filesystem version 4.
btrfs: B-Tree filesystem.
xfs: XFS from Sun Microsystems.
fat16: FAT16 filesystem, can not be used as the root filesystem.
fat32: FAT32 filesystem, can not be used as the root filesystem.
none: Not to be formatted.

[[partition]]
# other fields ...
filesystem = "ext4"

§`fs_label` - Filesystem label (Optional)

Label of the filesystem. Its limitation varies by filesystem type.

[[partition]]
# other fields ...
fs_label = "AOSC OS"

§`mountpoint` - Mount point of the filesystem

Where the filesystem should be mounted in the target OS. A partition without a filesystem can not be mounted.

The root filesystem must have a mountpoint “/”.

[[partition]]
# other fields ...
mountpoint = "/boot/firmware"

§`mount_opts` - Mount options (Optional)

Mount options used to mount the filesystem. This will be present in the generated /etc/fstab.

The handling of the mount options is not complete, only options specific to the filesystem type are allowed.

That is, options like ro, noexec and nosuid are not handled, and will result in an error if specified.

If not defined, defaults will be used. If defined, defaults will not be joined with the options.

mount_opts = ["compress=zstd"]

§`usage` - Usage of the partition

Describes the intended use of the partition.

Possible values are:

boot: Boot partition. Only one boot partition is allowed, and will be marked as active if MBR is used.
rootfs: Root filesystem. Only one root partition is allowed.
data: Data partition.
Other: Other uses.

§Examples

§Raspberry Pi 4 and onwards

Here’s an example for the Raspberry Pi 4 and later models.

Raspberry Pi 4 and later models supports GPT partition table. The OS image contains one boot partition formatted as FAT32, and one partition for the root filesystem formatted as ext4.

# The boot partition
[[partition]]
num = 1
type = "esp"
size_in_sectors = 614400
mountpoint = "/boot/rpi"
filesystem = "fat32"
usage = "boot"

# The root partition
[[partition]]
num = 2
type = "linux"
size_in_sectors = 0
mountpoint = "/"
filesystem = "ext4"
usage = "rootfs"

§Rockchip boards

Rockchip SoCs commonly uses the following partitioning scheme:

# Partition containing U-Boot TPL and SPL, 7.9MiB
[[partition]]
num = 1
start_sector = 64
# Let's assume it is a basic data partition.
type = "basic"
size_in_sectors = 16320
label = "U-Boot-TPL"
usage = "other"

# Partition containing the U-Boot proper, 8MiB
[[partition]]
num = 2
start_sector = 16384
type = "basic"
size_in_sectors = 16384
label = "U-Boot"
usage = "other"

# EFI System Partition used by U-Boot, 300MiB
[[partition]]
num = 3
type = "esp"
size_in_sectors = 614400
label = "EFI"
filesystem = "fat32"
mountpoint = "/efi"
usage = "boot"

# Root filesystem, btrfs with ZStandard compression
[[partition]]
num = 4
type = "linux"
label = "Root"
size_in_sectors = 0
filesystem = "btrfs"
mount_opts = ["compress=zstd"]
mountpoint = "/"
usage = "rootfs"

Fields§

§num: u32§part_type: PartitionType§start_sector: Option<u64>§size_in_sectors: u64§label: Option<String>§mountpoint: Option<String>§filesystem: FilesystemType§mount_opts: Option<Vec<String>>§fs_label: Option<String>§usage: PartitionUsage

Struct PartitionSpecCopy item path

§Partition specification

§Fields

§num - Partition number

§type - Partition Type

§start_sector - Starting position (Optional)

§size_in_sectors - Partition size

§label - Partition label (GPT Only, Optional)

§filesystem - Filesystem contained in the partition

§fs_label - Filesystem label (Optional)

§mountpoint - Mount point of the filesystem

§mount_opts - Mount options (Optional)

§usage - Usage of the partition

§Examples

§Raspberry Pi 4 and onwards

§Rockchip boards

Fields§

Trait Implementations§

impl Clone for PartitionSpec

fn clone(&self) -> PartitionSpec

fn clone_from(&mut self, source: &Self)

impl Debug for PartitionSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<'de> Deserialize<'de> for PartitionSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl PartialEq for PartitionSpec

fn eq(&self, other: &PartitionSpec) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Serialize for PartitionSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

impl Eq for PartitionSpec

impl StructuralPartialEq for PartitionSpec

Auto Trait Implementations§

impl Freeze for PartitionSpec

impl RefUnwindSafe for PartitionSpec

impl Send for PartitionSpec

impl Sync for PartitionSpec

impl Unpin for PartitionSpec

impl UnwindSafe for PartitionSpec

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

impl<T> Conv for T

fn conv<T>(self) -> Twhere Self: Into<T>,

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Struct PartitionSpec

§`num` - Partition number

§`type` - Partition Type

§`start_sector` - Starting position (Optional)

§`size_in_sectors` - Partition size

§`label` - Partition label (GPT Only, Optional)

§`filesystem` - Filesystem contained in the partition

§`fs_label` - Filesystem label (Optional)

§`mountpoint` - Mount point of the filesystem

§`mount_opts` - Mount options (Optional)

§`usage` - Usage of the partition

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

fn conv<T>(self) -> T
where Self: Into<T>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

impl<T, U> Into<U> for T
where U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn if_supports_color<'a, Out, ApplyFn>( &'a self, stream: impl Into<Stream>, apply: ApplyFn, ) -> SupportsColorsDisplay<'a, Self, Out, ApplyFn>
where ApplyFn: Fn(&'a Self) -> Out,

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,