Struct FormatDriverBuilderBase

pub struct FormatDriverBuilderBase<S: Storage> {
    image: StorageOrPath<S>,
    writable: bool,
    storage_opts: Option<StorageOpenOptions>,
}

Image open builder with the most basic options.

Fields

image: StorageOrPath<S>

Metadata (image) file

writable: bool

Whether the image is writable or not

storage_opts: Option<StorageOpenOptions>

Options to be used for implicitly opened storage

Implementations

impl<S: Storage> FormatDriverBuilderBase<S>

fn do_new(image: StorageOrPath<S>) -> Self

Create a new instance of this type.

pub fn new(image: S) -> Self

Helper for FormatDriverBuilder::new().

pub fn new_path<P: AsRef<Path>>(path: P) -> Self

Helper for FormatDriverBuilder::new_path().

pub fn set_write(&mut self, writable: bool)

Helper for FormatDriverBuilder::write().

pub fn set_storage_open_options(&mut self, options: StorageOpenOptions)

Helper for FormatDriverBuilder::storage_open_options().

pub fn get_image_path(&self) -> Option<PathBuf>

If possible, get the image’s path.

pub fn get_writable(&self) -> bool

Return the set writable state.

pub fn get_storage_opts(&self) -> Option<&StorageOpenOptions>

Return the set storage options (if any).

pub fn make_storage_opts(&self) -> StorageOpenOptions

Create storage options.

If any were set, return those, overriding their writable state based on the set writable state (FormatDriverBuilderBase::set_write()). Otherwise, create an empty set (again with the writable state set as appropriate).

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

Open the image’s storage object.