Struct Pk2 

pub struct Pk2<Buffer, L: LockChoice> { /* private fields */ }

A Pk2 archive.

Implementations

impl<L: LockChoice> Pk2<File, L>

pub fn create_new<P: AsRef<Path>, K: AsRef<[u8]>>( path: P, key: K, ) -> OpenResult<Self>

Creates a new File based archive at the given path.

pub fn open<P: AsRef<Path>, K: AsRef<[u8]>>(path: P, key: K) -> OpenResult<Self>

Opens an archive at the given path.

Note this eagerly parses the whole archive’s file table into memory incurring a lot of read operations on the file making this operation potentially slow.

impl<L: LockChoice> Pk2<ReadOnly<File>, L>

pub fn open_readonly<P: AsRef<Path>, K: AsRef<[u8]>>( path: P, key: K, ) -> OpenResult<Self>

Opens an archive at the given path.

Note this eagerly parses the whole archive’s file table into memory incurring a lot of read operations on the file making this operation potentially slow.

impl<L: LockChoice> Pk2<Cursor<Vec<u8>>, L>

pub fn create_new_in_memory<K: AsRef<[u8]>>(key: K) -> Result<Self, InvalidKey>

Creates a new archive in memory.

impl<B, L> Pk2<B, L>

where B: Read + Seek, L: LockChoice,

pub fn chain_index(&self) -> &ChainIndex

Returns a reference to the chain index.

pub fn open_in<K: AsRef<[u8]>>(stream: B, key: K) -> OpenResult<Self>

Opens an archive from the given stream.

Note this eagerly parses the whole archive’s file table into memory incurring a lot of read operations on the stream.

impl<B, L> Pk2<B, L>

where B: Read + Write + Seek, L: LockChoice,

pub fn create_new_in<K: AsRef<[u8]>>(stream: B, key: K) -> OpenResult<Self>

impl<B, L: LockChoice> Pk2<B, L>

pub fn open_file<P: AsRef<str>>(&self, path: P) -> OpenResult<File<'_, B, L>>

pub fn open_directory<P: AsRef<str>>( &self, path: P, ) -> OpenResult<Directory<'_, B, L>>

pub fn open_root_dir(&self) -> Directory<'_, B, L>

pub fn for_each_file( &self, base: impl AsRef<str>, cb: impl FnMut(&Path, File<'_, B, L>) -> OpenResult<()>, ) -> OpenResult<()>

Invokes cb on every file in the sub directories of base, including files inside of its subdirectories. Cb gets invoked with its relative path to base and the file object.

impl<B, L> Pk2<B, L>

where B: Read + Seek, L: LockChoice,

pub fn read<P: AsRef<str>>(&self, path: P) -> OpenResult<Vec<u8>>

impl<B, L> Pk2<B, L>

where B: Read + Write + Seek, L: LockChoice,

pub fn open_file_mut<P: AsRef<str>>( &mut self, path: P, ) -> OpenResult<FileMut<'_, B, L>>

pub fn delete_file<P: AsRef<str>>(&mut self, path: P) -> OpenResult<()>

Currently only replaces the entry with an empty one making the data inaccessible by normal means

pub fn create_file<P: AsRef<str>>( &mut self, path: P, ) -> OpenResult<FileMut<'_, B, L>>

pub fn create_file_truncate<P: AsRef<str>>( &mut self, path: P, ) -> OpenResult<FileMut<'_, B, L>>

Creates a file at the given path, or truncates it if it already exists.

If the file already exists, it will be opened for writing with its contents discarded. The existing file entry is retained. If the file does not exist, a new file is created.

Trait Implementations

impl<L: LockChoice> From<Pk2<Cursor<Vec<u8>>, L>> for Vec<u8>

fn from(pk2: Pk2<Cursor<Vec<u8>>, L>) -> Self

Converts to this type from the input type.