Struct Archive

pub struct Archive<'bytes> { /* private fields */ }

Represents the FO4 revision of the ba2 format.

Implementations

impl<'bytes> Archive<'bytes>

pub fn clear(&mut self)

pub fn get<K>(&self, key: &K) -> Option<&File<'bytes>>

where K: Borrow<FileHash>,

pub fn get_key_value<K>(&self, key: &K) -> Option<(&Key<'bytes>, &File<'bytes>)>

where K: Borrow<FileHash>,

pub fn get_mut<K>(&mut self, key: &K) -> Option<&mut File<'bytes>>

where K: Borrow<FileHash>,

pub fn insert<K>(&mut self, key: K, value: File<'bytes>) -> Option<File<'bytes>>

where K: Into<Key<'bytes>>,

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = (&Key<'bytes>, &File<'bytes>)>

pub fn iter_mut( &mut self, ) -> impl Iterator<Item = (&Key<'bytes>, &mut File<'bytes>)>

pub fn keys(&self) -> impl Iterator<Item = &Key<'bytes>>

pub fn len(&self) -> usize

pub fn new() -> Self

pub fn remove<K>(&mut self, key: &K) -> Option<File<'bytes>>

where K: Borrow<FileHash>,

pub fn remove_entry<K>( &mut self, key: &K, ) -> Option<(Key<'bytes>, File<'bytes>)>

where K: Borrow<FileHash>,

pub fn values(&self) -> impl Iterator<Item = &File<'bytes>>

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut File<'bytes>>

impl<'bytes> Archive<'bytes>

pub fn write<Out>(&self, stream: &mut Out, options: &Options) -> Result<()>

where Out: ?Sized + Write,

Trait Implementations

impl<'bytes> Clone for Archive<'bytes>

fn clone(&self) -> Archive<'bytes>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'bytes> Debug for Archive<'bytes>

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

Formats the value using the given formatter.

impl<'bytes> Default for Archive<'bytes>

fn default() -> Archive<'bytes>

Returns the “default value” for a type.

impl<'bytes> FromIterator<(Key<'bytes>, File<'bytes>)> for Archive<'bytes>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = (Key<'bytes>, File<'bytes>)>,

Creates a value from an iterator.

impl<'bytes, 'this> IntoIterator for &'this Archive<'bytes>

type Item = <&'this BTreeMap<Key<'bytes>, File<'bytes>> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'this BTreeMap<Key<'bytes>, File<'bytes>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'bytes, 'this> IntoIterator for &'this mut Archive<'bytes>

type Item = <&'this mut BTreeMap<Key<'bytes>, File<'bytes>> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'this mut BTreeMap<Key<'bytes>, File<'bytes>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'bytes> IntoIterator for Archive<'bytes>

type Item = <BTreeMap<Key<'bytes>, File<'bytes>> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <BTreeMap<Key<'bytes>, File<'bytes>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Reader<&File> for Archive<'static>

type Error = Error

type Item = (Archive<'static>, Options)

fn read(source: &File) -> Result<Self::Item>

Reads an instance of Self::Item from the given source.

impl Reader<&Path> for Archive<'static>

type Error = Error

type Item = (Archive<'static>, Options)

fn read(source: &Path) -> Result<Self::Item>

Reads an instance of Self::Item from the given source.

impl<'bytes> Reader<Borrowed<'bytes>> for Archive<'bytes>

type Error = Error

type Item = (Archive<'bytes>, Options)

fn read(source: Borrowed<'bytes>) -> Result<Self::Item>

Reads an instance of Self::Item from the given source.

impl<'bytes> Reader<Copied<'bytes>> for Archive<'static>

type Error = Error

type Item = (Archive<'static>, Options)

fn read(source: Copied<'bytes>) -> Result<Self::Item>

Reads an instance of Self::Item from the given source.