Struct Vmdk

pub struct Vmdk<S: Storage + 'static, F: WrappedFormat<S> + 'static = FormatAccess<S>> {
    descriptor_file: Arc<S>,
    parent_type: PhantomData<F>,
    storage_open_options: StorageOpenOptions,
    size: AtomicU64,
    desc: VmdkDesc,
    parsed_extents: Vec<VmdkParsedExtent>,
    extents: Vec<VmdkExtent<S>>,
}

VMDK disk image format implementation.

Fields

descriptor_file: Arc<S>

Storage object containing the VMDK descriptor file

parent_type: PhantomData<F>

Backing image type.

We do not support backing (parent) images yet, but capture the type so that when we do support it, the change will be syntactically compatible.

storage_open_options: StorageOpenOptions

Base options to be used for implicitly opened storage objects.

size: AtomicU64

Virtual disk size in bytes.

desc: VmdkDesc

Parsed VMDK descriptor.

parsed_extents: Vec<VmdkParsedExtent>

Extent information as parsed from the VMDK descriptor file.

extents: Vec<VmdkExtent<S>>

Storage objects for each extent.

Implementations

impl<S: Storage + 'static, F: WrappedFormat<S> + 'static> Vmdk<S, F>

pub fn builder(image: S) -> VmdkOpenBuilder<S, F>

Create a new FormatDriverBuilder instance for the given image.

pub fn builder_path<P: AsRef<Path>>(image_path: P) -> VmdkOpenBuilder<S, F>

Create a new FormatDriverBuilder instance for an image under the given path.

async fn open_implicit_extent<G: ImplicitOpenGate<S>>( &self, extent: &VmdkParsedExtent, in_disk_offset: u64, open_gate: &mut G, ) -> Result<VmdkExtent<S>>

Open an extent from the information in extent.

in_disk_offset is the offset in the virtual disk where this extent fits in. It should be the end offset of the extent before it.

fn error_out_unsupported_version(&self) -> Result<()>

Checks if the VMDK version is supported and returns an error if not

fn parse_descriptor_line(&mut self, line: &str) -> Result<()>

Parse a line in the VMDK descriptor file

async fn parse_descriptor_file(&mut self) -> Result<()>

Read and parse the VMDK descriptor by reading in lines until we find the end

async fn do_open( descriptor_file: S, storage_open_options: StorageOpenOptions, ) -> Result<Self>

Internal implementation for opening a VMDK image.

pub async fn open_image(descriptor_file: S, writable: bool) -> Result<Self>

Opens a VMDK file.

This will not open any other storage objects needed, i.e. no extent data files. Handling those manually is not yet supported, so you have to make use of the implicit references given in the image header, for which you can use Vmdk::open_implicit_dependencies_gated().

pub async fn open_implicit_dependencies_gated<G: ImplicitOpenGate<S>>( &mut self, gate: G, ) -> Result<()>

Open all implicit dependencies.

In the case of VMDK, these are the extent data files.

fn get_extent_at(&self, offset: u64) -> Option<&VmdkExtent<S>>

Return the extent covering offset, if any.

Trait Implementations

impl<S: Debug + Storage + 'static, F: Debug + WrappedFormat<S> + 'static> Debug for Vmdk<S, F>

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

Formats the value using the given formatter.

impl<S: Storage + 'static, F: WrappedFormat<S> + 'static> Display for Vmdk<S, F>

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

Formats the value using the given formatter.

impl<S: Storage + 'static, F: WrappedFormat<S> + 'static> FormatDriverInstance for Vmdk<S, F>

type Storage = S

Type of storage used.

fn format(&self) -> Format

Return which format this is.

unsafe fn probe<'life0, 'async_trait>( storage: &'life0 S, ) -> Pin<Box<dyn Future<Output = Result<bool>> + 'async_trait>>

where Self: Sized + 'async_trait, 'life0: 'async_trait,

Check whether storage has this format.

fn size(&self) -> u64

Size of the disk represented by this image.

fn zero_granularity(&self) -> Option<u64>

Granularity on which blocks can be marked as zero.

fn collect_storage_dependencies(&self) -> Vec<&S>

Recursively collect all storage objects associated with this image.

fn writable(&self) -> bool

Return whether this image may be modified.

fn get_mapping<'a, 'async_trait>( &'a self, offset: u64, max_length: u64, ) -> Pin<Box<dyn Future<Output = Result<(ShallowMapping<'a, S>, u64)>> + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

Return the mapping at offset.

fn ensure_data_mapping<'a, 'async_trait>( &'a self, _offset: u64, _length: u64, _overwrite: bool, ) -> Pin<Box<dyn Future<Output = Result<(&'a S, u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

Ensure that offset is directly mapped to some storage object, up to a length of length.

fn flush<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Flush internal buffers.

fn sync<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sync data already written to the storage hardware.

unsafe fn invalidate_cache<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Drop internal buffers.

fn resize_grow<'life0, 'async_trait>( &'life0 self, _new_size: u64, _prealloc_mode: PreallocateMode, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Resize to the given size, which must be greater than the current size.

fn resize_shrink<'life0, 'async_trait>( &'life0 mut self, _new_size: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Truncate to the given size, which must be smaller than the current size.

fn ensure_zero_mapping<'life0, 'async_trait>( &'life0 self, _offset: u64, _length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Ensure that the given range is efficiently mapped as zeroes.

fn discard_to_zero<'life0, 'async_trait>( &'life0 mut self, offset: u64, length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Discard the given range, ensure it is read back as zeroes.

unsafe fn discard_to_zero_unsafe<'life0, 'async_trait>( &'life0 self, _offset: u64, _length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Discard the given range, ensure it is read back as zeroes.

fn discard_to_any<'life0, 'async_trait>( &'life0 mut self, offset: u64, length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Discard the given range.

unsafe fn discard_to_any_unsafe<'life0, 'async_trait>( &'life0 self, _offset: u64, _length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Discard the given range.

fn discard_to_backing<'life0, 'async_trait>( &'life0 mut self, offset: u64, length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Discard the given range, such that the backing image becomes visible.

unsafe fn discard_to_backing_unsafe<'life0, 'async_trait>( &'life0 self, _offset: u64, _length: u64, ) -> Pin<Box<dyn Future<Output = Result<(u64, u64)>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Discard the given range, such that the backing image becomes visible.

fn readv_special<'life0, 'life1, 'async_trait>( &'life0 self, _bufv: IoVectorMut<'life1>, _offset: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read data from a ShallowMapping::Special area.