Struct pzip::PZip

pub struct PZip { /* private fields */ }

Structure for holding information about a PZip archive, and a namespace for common operations.

Implementations

impl PZip

pub fn reader<'r, T: Read>(
    reader: &'r mut T,
    key_material: &[u8]
) -> Result<PZipReader<'r, T>, Error>

Returns a PZipReader after reading the PZip header and tag data.

This method first reads the PZip header and does some validation. So in addition to Error::IoError caused by read failures, it may also return Error::IncorrectMagic if the file magic is incorrect, or Error::UnknownVersion if an unknown version is specified. Any of the other Unknown* errors may also be returned when trying to parse the algorithm, KDF, compression method, or tags.

pub fn writer<'r, T: Write, K: PZipKey>(
    writer: &'r mut T,
    algorithm: Algorithm,
    key: &K,
    compression: Compression
) -> Result<PZipWriter<'r, T>, Error>

Returns a PZipWriter with the specified algorithm, key, and compression.

pub fn decrypt(ciphertext: &[u8], key_material: &[u8]) -> Result<Vec<u8>, Error>

One-shot decryption.

pub fn decrypt_to<R: Read, W: Write>(
    input: &mut R,
    output: &mut W,
    key_material: &[u8]
) -> Result<usize, Error>

Streaming decryption.

pub fn encrypt<K: PZipKey>(
    plaintext: &[u8],
    algorithm: Algorithm,
    key: &K,
    compression: Compression
) -> Result<Vec<u8>, Error>

One-shot encryption.

pub fn encrypt_to<R: Read, W: Write, K: PZipKey>(
    input: &mut R,
    output: &mut W,
    algorithm: Algorithm,
    key: &K,
    compression: Compression
) -> Result<usize, Error>

Streaming encryption.