Struct DiskLayoutFile

pub struct DiskLayoutFile { /* private fields */ }

A disk layout file.

Implementations

impl DiskLayoutFile

pub fn new(max_address: u128) -> Self

Construct a new disk layout file with just an ending address.

pub fn version(&self) -> String

Get the version string that would appear in the DLF file.

pub const fn major_version(&self) -> u8

Get the major version of this disk layout file.

pub const fn minor_version(&self) -> u8

Get the minor version of this disk layout file.

pub const fn max_address(&self) -> u128

Get the max address on this DLF.

pub fn address_to_path_map(&self) -> &BTreeMap<u128, PathBuf>

Get the current mapping of addresses to paths on the host filesystem.

pub async fn get_path_and_offset_for_file( &self, requested_address: u128, ) -> Option<(&PathBuf, u64)>

Get the path at a particular address.

pub fn upsert_addressed_path( &mut self, address: u128, path: &Path, ) -> Result<(), CatBridgeError>

Insert, or update the path at a particular address.

Errors

• If you try to write an address past [MAX_ADDRESS].
• If you try inserting an address past the ending of PATH.
• If we cannot canonicalize the path you past in.

pub fn remove_path_at_address( &mut self, address: u128, ) -> Result<(), FSEmulAPIError>

Remove a path at a particular address.

Errors

If you try to remove the ending address for the DLF file. DLF files do require an ending.

Trait Implementations

impl Clone for DiskLayoutFile

fn clone(&self) -> DiskLayoutFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DiskLayoutFile

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

Formats the value using the given formatter.

impl From<&DiskLayoutFile> for Bytes

fn from(value: &DiskLayoutFile) -> Self

Converts to this type from the input type.

impl From<DiskLayoutFile> for Bytes

fn from(value: DiskLayoutFile) -> Self

Converts to this type from the input type.

impl PartialEq for DiskLayoutFile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Bytes> for DiskLayoutFile

type Error = FSError

The type returned in the event of a conversion error.

fn try_from(value: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DiskLayoutFile

impl StructuralPartialEq for DiskLayoutFile