Adding `imago` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add imago

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

imago = "0.2.4"

The imago library will be automatically available globally. Read the imago library documentation.

Back to the crate overview.

Readme

Imago

Provides access to VM image formats.

Documentation:

Stable (released): https://docs.rs/imago
main branch: https://hreitz.gitlab.io/imago
sync feature: https://hreitz.gitlab.io/imago/sync

Simple example (requires the sync feature):

use imago::file::File;
use imago::qcow2::Qcow2;
use imago::{FormatAccess, FormatDriverBuilder, PermissiveImplicitOpenGate};

let qcow2 =
    Qcow2::<File>::builder_path("image.qcow2").open(PermissiveImplicitOpenGate::default())?;

let qcow2 = FormatAccess::new(qcow2);

let mut buf = vec![0u8; 512];
qcow2.read(&mut buf, 0)?;

Another example, using the native async interface instead of sync wrapper functions, explicitly overriding the implicit references contained in qcow2 files, and showcasing using different types of storage (specifically normal files and null storage):

use imago::file::File;
use imago::null::Null;
use imago::qcow2::Qcow2;
use imago::raw::Raw;
use imago::{
    DenyImplicitOpenGate, DynStorage, FormatAccess, FormatDriverBuilder,
    PermissiveImplicitOpenGate, Storage, StorageOpenOptions,
};
use std::sync::Arc;

// Produce qcow2 instance with arbitrary (and potentially mixed) storage instances
// (By using `Box<dyn DynStorage>` as the `Storage` type.)

let backing_storage: Box<dyn DynStorage> = Box::new(Null::new(0));
let backing = Raw::builder(backing_storage)
    .open(DenyImplicitOpenGate::default())
    .await?;
let backing = Arc::new(FormatAccess::new(backing));

// `Box<dyn DynStorage>::open()` defaults to using the `imago::file::File` driver, so we can
// use paths with `Box<dyn DynStorage>`, too.
// Despite explicitly setting a backing image, we still need `PermissiveImplicitOpenGate`
// instead of `DenyImplicitOpenGate`, because `builder_path()` will need to implicitly open
// that storage object.  Passing an explicitly opened storage object via `builder()` would
// remedy that.
let qcow2 = Qcow2::builder_path("image.qcow2")
    .storage_open_options(StorageOpenOptions::new().direct(true))
    .write(true)
    .backing(Some(Arc::clone(&backing)))
    .open(PermissiveImplicitOpenGate::default())
    .await?;

let qcow2 = FormatAccess::new(qcow2);

let mut buf = vec![0u8; 512];
qcow2.read(&mut buf, 0).await?;

qcow2.flush().await?;

Flushing

In async mode, given that AsyncDrop is not stable yet (and probably will not be stable for a long time), callers must ensure that images are properly flushed before dropping them, i.e. call .flush().await on any image that is not read-only.

(The synchronous wrapper SyncFormatAccess does perform a synchronous flush in its Drop implementation.)

In sync mode, FormatAccess implements Drop and flushes automatically.

Features

async (default): Build with async support, which requires tokio (for async locking), async-trait, and futures.
sync: Build as a fully synchronous library, with no async, no tokio dependency. All I/O methods become plain fn. Enable via imago = { default-features = false, features = ["sync"] }. Incompatible with async and sync-wrappers.
sync-wrappers: Provide synchronous wrappers for the native async interface. Note that these build a tokio runtime in which they run the async functions, so prefer using sync instead, which provides native synchronous methods without the tokio overhead. Incompatible with sync, and planned to be deprecated in the future.
vm-memory: Provide conversion functions IoVector::from_volatile_slice and IoVectorMut::from_volatile_slice to convert the vm-memory crate’s [VolatileSlice] arrays into imago’s native I/O vectors.

Adding imago library as a dependency

Adding `imago` library as a dependency