Struct CreateOptions 

pub struct CreateOptions<T = File> { /* private fields */ }

Builder for creating a new VHDX file.

Implementations

impl<T> CreateOptions<T>

pub fn size(self, virtual_size: u64) -> Self

Set the virtual disk size in bytes (required).

Must be a multiple of logical_sector_size and at most 64 TB.

pub fn fixed(self, fixed: bool) -> Self

Set whether this is a fixed-size disk (default: dynamic).

pub fn block_size(self, size: u32) -> Self

Set the payload block size in bytes (default: 32 MB).

Must be in [1 MB, 256 MB] and a power of two.

pub fn logical_sector_size(self, size: u32) -> Self

Set the logical sector size in bytes (default: 4096).

Must be 512 or 4096.

pub fn physical_sector_size(self, size: u32) -> Self

Set the physical sector size in bytes (default: 4096).

Must be 512 or 4096.

pub fn parent<P>( self, parent: &mut Medium<P>, relative_path: impl AsRef<Path>, ) -> Result<Self>

where P: Read + Seek,

Set caller-provided parent metadata for a differencing disk.

Errors

Returns an error if the parent medium’s Data Write GUID cannot be read.

pub fn finish(self) -> Result<Medium<T>>

where T: Read + Write + Seek + Len + SetLen + SyncData,

Create the VHDX on the caller-provided medium.

Writes the File Type Identifier, both Headers, both Region Tables, the BAT region (initialised per disk type), the full Metadata table and items, and — for fixed disks — pre-allocates and zero-fills all payload blocks.

Errors

Returns an error if validation fails, the file cannot be created, or any write operation fails.

Panics

Panics if this builder has already had its inner medium taken.