Struct Archive

pub struct Archive { /* private fields */ }

Implementations

impl Archive

pub fn new() -> Self

Creates a new archive with an empty entry table.

impl Archive

pub fn contains_key<S>(&self, key: S) -> bool

where S: Into<String>,

Returns true if the entry table contains the specified key.

pub fn remove<S>(&mut self, key: S) -> Option<Vec<u8>>

where S: Into<String>,

Removes an entry.

pub fn clear(&mut self)

Clears the entry table of this archive

pub fn len(&self) -> usize

Returns the number of entries this archive contains.

Examples found in repository

examples/read_file.rs (line 10)

fn main() -> Result<()> {
    let path = Path::new("release/jagex.jag");
    let archive = Archive::try_from(path)?;

    println!("archive entry size: {}", archive.len());
    Ok(())
}

pub fn is_empty(&self) -> bool

Returns true if the archive contains no entries

Trait Implementations

impl Clone for Archive

fn clone(&self) -> Archive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Archive

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

Formats the value using the given formatter.

impl Default for Archive

fn default() -> Archive

Returns the “default value” for a type.

impl ReadArchive for Archive

fn get<S>(&self, key: S) -> Option<&Vec<u8>>

where S: Into<String>,

Gets a reference to an entry from an archive, if it exists.

fn get_mut<S>(&mut self, key: S) -> Option<&mut Vec<u8>>

where S: Into<String>,

Gets a mutable reference to an entry from an archive, if it exists.

impl TryFrom<&Path> for Archive

fn try_from(path: &Path) -> Result<Self, Error>

Attempts to read an existing archive from disk into a new archive.

type Error = Error

The type returned in the event of a conversion error.

impl WriteArchive for Archive

fn save(&self, path: &Path) -> Result<()>

Writes an archive to disk with the given path. If a file is already present at the given path, it is simply overwritten.

fn insert<S>(&mut self, key: S, value: Vec<u8>) -> Option<Vec<u8>>

where S: Into<String>,

Inserts a key-value pair. If the archive already contains the given key, the previous value for that key is returned.