Skip to main content

PlanRequest

Struct PlanRequest 

Source
#[non_exhaustive]
pub struct PlanRequest { pub volume_bytes: u64, pub bytes_per_sector: u32, pub cluster_size: ClusterSize, pub boundary_align: BoundaryAlign, }
Expand description

What to plan.

Every input is a field rather than a parameter, so a knob the planner grows arrives as a field a caller may ignore.

// A 512 MiB volume, formatted the way convention formats one.
let layout = plan_layout(&PlanRequest::new(512 << 20))?;
assert_eq!(layout.bytes_per_sector, 512);
assert_eq!(layout.bytes_per_cluster, 32 << 10);

// The same volume with the allocation unit pinned, which moves everything behind it.
let small = plan_layout(&PlanRequest::new(512 << 20).cluster_size(ClusterSize::Bytes(512)))?;
assert_eq!(small.cluster_count, 1_038_336);
assert!(small.cluster_count > layout.cluster_count);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§volume_bytes: u64

The volume’s size in bytes. A size that is not a whole number of sectors is rounded down, since a partial sector is not addressable.

§bytes_per_sector: u32

Bytes per logical sector: 512, 1024, 2048, or 4096. Defaults to 512.

§cluster_size: ClusterSize

The allocation unit. Defaults to ClusterSize::Auto.

§boundary_align: BoundaryAlign

The boundary the allocation table and the cluster heap begin on. Defaults to BoundaryAlign::Auto.

Implementations§

Source§

impl PlanRequest

Source

pub const fn new(volume_bytes: u64) -> Self

A request for a volume of volume_bytes, with every knob at the value convention selects for a volume that size.

Source

pub const fn bytes_per_sector(self, bytes: u32) -> Self

This request with the sector size replaced.

Source

pub const fn cluster_size(self, size: ClusterSize) -> Self

This request with the allocation unit replaced.

Source

pub const fn boundary_align(self, align: BoundaryAlign) -> Self

This request with the alignment boundary replaced.

Trait Implementations§

Source§

impl Clone for PlanRequest

Source§

fn clone(&self) -> PlanRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PlanRequest

Source§

impl Debug for PlanRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PlanRequest

Source§

impl PartialEq for PlanRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PlanRequest

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.