Struct webc::v1::WebCOwned

pub struct WebCOwned {
    pub webc: WebC<'static>,
    /* private fields */
}

Owned version of the WebC file that carries its data along the parsed WebC<'static>

Fields

webc: WebC<'static>

Implementations

impl WebCOwned

pub fn parse(data: impl Into<Bytes>, options: &ParseOptions) -> ReadResult<Self>

Same as WebC::parse, but keeps the resulting data in memory, instead of referencing it

pub fn as_webc_ref(&self) -> WebC<'_>

Methods from Deref<Target = WebC<'static>>

pub fn get_main_args_for_command( &self, command: &str ) -> Result<Vec<String>, String>

pub fn get_atom_name_for_command( &self, api: &str, command: &str ) -> Result<String, String>

pub fn get_volumes_for_package(&self, package: &str) -> Vec<String>

Determines the available volumes for a given package

pub fn list_directories(&self, volume: &str) -> Vec<String>

pub fn read_dir( &self, package: &str, path: &str ) -> Result<Vec<FsEntry<'a>>, Error>

Returns the directory entries or an error if the directory does not exist

pub fn get_file_entry( &self, package: &str, path: &str ) -> Option<(String, OwnedFsEntryFile)>

Looks for the first volume containing “entry”, scoped to the given package

pub fn get_metadata(&self) -> &Manifest

Returns a reference to the manifest

pub fn get_package_name(&self) -> String

Returns the current package name with

pub fn get_atom(&self, package: &str, atom: &str) -> Result<&[u8], Error>

Returns an atom by name for a given package

pub fn get_volume(&self, package: &str, volume: &str) -> Option<&Volume<'a>>

Returns a reference to the filesystem volume of the package

pub fn get_file(&self, package: &str, file_path: &str) -> Result<&[u8], Error>

Returns a file for a given package - if you want to use a non-default volume, prefix the file_path with volume://, for example, metadata://README.md

pub fn list_volumes(&self, package: &str) -> Vec<String>

Returns a list of volumes for this package

pub fn list_packages(&self) -> Vec<PackageInfo>

Returns a list of bundled “package@version” strings contained in this package

pub fn list_atoms(&self) -> Vec<String>

Returns the atoms in the root package

pub fn get_all_atoms(&self) -> IndexMap<String, &'a [u8]>

Returns a list of all atoms with bytes

pub fn list_atoms_for_package(&self, package_orig: &str) -> Vec<String>

List the atoms for a given package

pub fn list_commands(&self) -> Vec<&str>

List the available commands for the root package

pub fn get_volumes_as_fileblock(&self) -> Vec<u8>

pub fn into_bytes(&self, sign_bytes: GenerateChecksum) -> ReadResult<Vec<u8>>

Serialize the .webc file into bytes

Trait Implementations

impl Clone for WebCOwned

fn clone(&self) -> WebCOwned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebCOwned

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

Formats the value using the given formatter.

impl Deref for WebCOwned

type Target = WebC<'static>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<WebCOwned> for Container

fn from(value: WebCOwned) -> Self

Converts to this type from the input type.