Skip to main content

ByteStorage

Struct ByteStorage 

Source
pub struct ByteStorage { /* private fields */ }
Expand description

Raw byte storage engine (pure Rust core) Simple store/retrieve interface with no type awareness

Implementations§

Source§

impl ByteStorage

Source

pub fn new(default_format: Option<String>) -> Self

Create new ByteStorage instance

Source

pub fn store( &self, data: &[u8], format: Option<String>, ) -> Result<Vec<u8>, ByteStorageError>

Store arbitrary bytes with compression and checksums

Returns serialized StorageEnvelope bytes

Source

pub fn retrieve( &self, envelope_bytes: &[u8], ) -> Result<(Vec<u8>, String), ByteStorageError>

Retrieve and validate stored bytes

Returns (original_data, format_identifier)

§Errors

envelope_bytes is untrusted. Before it is decoded, a structural pre-scan bounds its nesting depth and rejects any header that declares more than the input can back (protocol Retrieve Flow, step 2). A pre-scan rejection is DeserializationFailed whose message starts with decode pre-scan: , the same variant as any other bytes that do not decode as a StorageEnvelope.

Source

pub fn estimate_compression(&self, data: &[u8]) -> Result<f64, ByteStorageError>

Get compression ratio for given data: input length over the length of the LZ4 block store() writes for it

Source

pub fn validate(&self, envelope_bytes: &[u8]) -> bool

Validate an envelope by fully extracting it and discarding the result

This runs extract_payload, so it decompresses the payload and allocates up to the decompression bound. It is not a cheap structural pre-screen for untrusted envelopes.

Source

pub fn max_uncompressed_size(&self) -> usize

Get security limits

Source

pub fn max_compressed_size(&self) -> usize

Source

pub fn max_compression_ratio(&self) -> u64

Trait Implementations§

Source§

impl Default for ByteStorage

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.