Struct asuran::repository::Chunk

pub struct Chunk { /* fields omitted */ }

A binary blob, ready to be commited to storage

A Chunk is an arbitrary sequence of bytes, along with its associated ChunkID key.

Data in a Chunk has already undergone any selected compression and encryption, and has an associated HMAC tag used for verifying the integrity of the data. This HMAC tag is unrelated to the ChunkID key, and uses a separate HMAC key.

Chunks are additionally tagged with the encryption and compression modes used for them.

Implementations

impl Chunk

pub fn pack(
    data: Vec<u8, Global>,
    compression: Compression,
    encryption: Encryption,
    hmac: HMAC,
    key: &Key
) -> Chunk

Produces a Chunk from the given data, using the specified encryption, and hmac algorithms, as well as the supplied key material.

Panics

Will panic if any of the compression, encryption, or HMAC operations fail. This would represent a massive programming oversight which the user of the library has little hope of recovering from safely without compromising cryptographic integrity.

pub fn from_parts(
    data: Vec<u8, Global>,
    compression: Compression,
    encryption: Encryption,
    hmac: HMAC,
    mac: Vec<u8, Global>,
    id: ChunkID
) -> Chunk

Constructs a Chunk from its raw parts.

This has potentially dangerous consequences if done incorrectly, and should be avoided if another method is available.

pub fn pack_with_id(
    data: Vec<u8, Global>,
    compression: Compression,
    encryption: Encryption,
    hmac: HMAC,
    key: &Key,
    id: ChunkID
) -> Chunk

Produces a Chunk using the provided settings, but overriding the ChunkID key.

This has the potential to do serious damage to a repository if used incorrectly, and should be avoided if another method is available.

pub fn unpack(&self, key: &Key) -> Result<Vec<u8, Global>, ChunkError>

Validates, decrypts, and decompresses the data in a Chunk.

Errors

Will return Err(HMACVailidationFailed) if the chunk fails validation.

Will return Err(EncryptionError) if decryption fails.

Will return Err(CompressionError) if decompression fails.

All of these error values indicate that the Chunk is corrupted or otherwise malformed.

pub fn len(&self) -> usize

Returns the length of the data in the Chunk

pub fn is_empty(&self) -> bool

Determine if this chunk is empty

pub fn get_bytes(&self) -> &[u8]

Returns a reference to the raw bytes of this chunk

pub fn get_id(&self) -> ChunkID

Returns the ChunkID key assocaited with the data in this chunk.

pub fn mac(&self) -> Vec<u8, Global>

Returns the mac value of this chunk

pub fn split(self) -> (ChunkHeader, ChunkBody)

Splits a Chunk into its header and body components

pub fn unsplit(header: ChunkHeader, body: ChunkBody) -> Chunk

Combines a header and a body into a Chunk

pub fn encryption(&self) -> Encryption

Returns a copy of the encryption method/iv used for the chunk

Trait Implementations

impl Clone for Chunk

pub fn clone(&self) -> Chunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Chunk

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Chunk, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Chunk> for Chunk

pub fn eq(&self, other: &Chunk) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Chunk

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Chunk