Struct webc::Container

pub struct Container { /* private fields */ }

A version-agnostic read-only WEBC container.

A Container provides a high-level interface for reading and manipulating WEBC container files. It supports multiple versions of WEBC container formats and abstracts the underlying differences between them.

Implementations

impl Container

pub fn from_disk(path: impl AsRef<Path>) -> Result<Self, ContainerError>

Load a Container from disk.

Where possible, this will try to use a memory-mapped implementation to reduce memory usage.

pub fn from_bytes(bytes: impl Into<Bytes>) -> Result<Self, ContainerError>

Load a Container from bytes in memory.

pub fn manifest(&self) -> &Manifest

Get the Container’s manifest.

pub fn atoms(&self) -> BTreeMap<String, OwnedBuffer>

Get all atoms stored in the container as a map.

pub fn get_atom(&self, name: &str) -> Option<OwnedBuffer>

Get an atom with the given name.

Returns None if the atom does not exist in the container.

This operation is pretty cheap, typically just a dictionary lookup followed by reference count bump and some index math.

pub fn volumes(&self) -> BTreeMap<String, Volume>

Get all volumes stored in the container.

pub fn get_volume(&self, name: &str) -> Option<Volume>

Get a volume with the given name.

Returns None if the volume does not exist in the container.

pub fn downcast_ref<T>(&self) -> Option<&T>where T: 'static,

Downcast the Container a concrete implementation.

pub fn downcast<T>(self) -> Result<Arc<T>, Self>where T: 'static,

Downcast the Container a concrete implementation, returning the original Container if the cast fails.

Trait Implementations

impl Clone for Container

fn clone(&self) -> Container

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Container

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

Formats the value using the given formatter.

impl From<OwnedReader> for Container

fn from(value: OwnedReader) -> Self

Converts to this type from the input type.

impl From<Package> for Container

fn from(value: Package) -> Self

Converts to this type from the input type.

impl From<WebCMmap> for Container

fn from(value: WebCMmap) -> Self

Converts to this type from the input type.

impl From<WebCOwned> for Container

fn from(value: WebCOwned) -> Self

Converts to this type from the input type.