Struct Volume

pub struct Volume { /* private fields */ }

A WEBC volume.

A Volume represents a collection of files and directories, providing methods to read file contents and traverse directories.

Example

#[cfg(not(feature = "v3"))]
#[cfg(feature = "v3")]
use webc::{Metadata, Volume};

fn get_webc_volume() -> Volume {
    /* ... */
                Timestamps::default(),
}
let another_hash: [u8; 32] = sha2::Sha256::digest(b"Another").into();
let file_hash: [u8; 32] = sha2::Sha256::digest(b"Hello, World!").into();
let to_hash: [u8; 32] = sha2::Sha256::digest(&file_hash).into();
let path_hash: [u8; 32] = sha2::Sha256::digest(&to_hash).into();

let volume = get_webc_volume();
// Accessing file content.
let (content, hash) = volume.read_file("/path/to/file.txt").unwrap();
assert_eq!(content, b"Hello, World!");
assert_eq!(hash, Some(file_hash));
// Inspect directories.
let timestamps = Some(webc::Timestamps::default());
let entries = volume.read_dir("/").unwrap();

assert_eq!(entries.len(), 2);
assert_eq!(entries[0], (
    PathSegment::parse("another.txt").unwrap(),
    Some(another_hash),
    Metadata::File { length: 7, timestamps },
));
assert_eq!(entries[1], (
    PathSegment::parse("path").unwrap(),
    Some(path_hash),
    Metadata::Dir { timestamps },
));

Implementations

impl Volume

pub fn metadata(&self, path: impl ToPathSegments) -> Option<Metadata>

Get the metadata of an item at the given path.

Returns None if the item does not exist in the volume or an internal error occurred.

pub fn read_dir( &self, path: impl ToPathSegments, ) -> Option<Vec<(PathSegment, Option<[u8; 32]>, Metadata)>>

Read the contents of a directory at the given path.

Returns a vector of directory entries, including their metadata, if the path is a directory.

Returns None if the path does not exist or is not a directory.

pub fn read_file( &self, path: impl ToPathSegments, ) -> Option<(OwnedBuffer, Option<[u8; 32]>)>

Read the contents of a file at the given path.

Returns None if the path is not valid or the file is not found.

pub fn unpack( &self, volume_path: impl ToPathSegments, out_dir: &Path, ) -> Result<(), ContainerError>

Unpack a subdirectory of this volume into a local directory.

Use ‘/’ as the volume_path to unpack the entire volume.

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Volume

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

Formats the value using the given formatter.

impl From<Arc<dyn AbstractVolume + Sync + Send>> for Volume

fn from(value: Arc<dyn AbstractVolume + Send + Sync + 'static>) -> Self

Converts to this type from the input type.

impl From<VolumeSection> for Volume

Available on crate feature v2 only.

fn from(value: VolumeSection) -> Self

Converts to this type from the input type.

impl From<VolumeSection> for Volume

Available on crate feature v3 only.

fn from(value: VolumeSection) -> Self

Converts to this type from the input type.