Struct snapper_box::file::segment::Segment

pub struct Segment<'a> { /* fields omitted */ }

A data segment within a file, encoded as vector of bytes and its length.

This type has both the ability to represent owned data, for normal copying reads, as well as owned data, for zero copy.

A valid segment has a length, encoded as an 8-byte little-endian integer, and a bytewise array of data of the specified length.

Implementations

impl<'a> Segment<'a>

pub fn read_borrowed(source: &'a [u8]) -> Result<Self, Error>

Parses and borrows a Segment from the provided data.

Errors

This will return Err(Error::SegmentLength) if

• The specified length is too big to possibly fit into memory
• There is not enough data in the slice to fill the data buffer

pub fn total_length(&self) -> usize

Provides the length, in bytes, that this value will take up if serialized. This count includes the embedded 8-byte length tag.

pub fn write_ref(&self, dest: &mut [u8]) -> Result<usize, Error>

Writes this segment to an array of bytes, returning the number of bytes written

Errors

Will return SegmentLength if the contained data is too big to fit in the buffer.

pub fn write(&self, dest: &mut impl Write) -> Result<usize, Error>

Writes this segment to an IO Write instance, returning the number of bytes written

Errors

Will pass through any underlying IO errors

pub fn new_borrowed(data: &'a [u8]) -> Self

Constructs a new segment from some borrowed data

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

Gets a reference to the inner data

impl Segment<'static>

pub fn read_owned(source: &mut impl Read) -> Result<Self, Error>

Copies a Segment from the provided IO Read

Errors

This will return Err(Error::SegmentIo) if

• The specified length is too big to possibly fit into memory
• There is not enough data in the slice to fill the data buffer

pub fn new(data: impl AsRef<[u8]>) -> Self

Constructs a new segment from some data

Trait Implementations

impl<'a> Clone for Segment<'a>

fn clone(&self) -> Segment<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Segment<'a>

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

Formats the value using the given formatter.

impl<'a> From<CipherText<'a>> for Segment<'static>

fn from(x: CipherText<'a>) -> Self

Encode a CipherText in binary form as a segment.

This will encode:

• The compressed flag - 0_u8 being false and 1_u8 being true
• The rest of the fields as a concatenation of their bytes

impl<'a> Hash for Segment<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<Segment<'a>> for Segment<'a>

fn eq(&self, other: &Segment<'a>) -> bool

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

fn ne(&self, other: &Segment<'a>) -> bool

This method tests for !=.

impl<'a> TryFrom<Segment<'a>> for CipherText<'a>

fn try_from(value: Segment<'a>) -> Result<Self, Self::Error>

Attempt to decode a Segment as a CipherText.

Errors

• Error::SegmentLength if there is a length mismatch
• Error::InvalidCompression if the compression flag is invalid

type Error = Error

The type returned in the event of a conversion error.

impl<'a> Eq for Segment<'a>

impl<'a> StructuralEq for Segment<'a>

impl<'a> StructuralPartialEq for Segment<'a>