Struct VersionedBytes 

pub struct VersionedBytes<'a> {
    pub format_identifier: [u8; 24],
    pub version: u64,
    pub data: &'a [u8],
}

A set of bytes accompanied by file header information.

Buffers deserialized using rkyv must be aligned to 16-byte boundaries. VersionedBytes is capable of preserving 16-byte memory alignment if the backing byte buffer is correctly aligned.

Fields

format_identifier: [u8; 24]

The magic bytes at the start of the file indicating the format used.

version: u64

The format version stored within the header.

data: &'a [u8]

The data following the header.

Implementations

impl<'a> VersionedBytes<'a>

pub fn try_from_bytes( value: &'a [u8], format_identifier: [u8; 24], ) -> Option<Self>

Tries to deserialize a VersionedBytes struct from a byte array.

This can fail in the following cases:

• The specified format_identifier does not match the first 24 bytes of the byte array
• The byte array is less than 32 bytes long

pub const fn output_length(&self) -> usize

The total length in bytes after serialization.

pub fn write_header<W>( &self, writer: &mut W, ) -> Result<(), <W as Fallible>::Error>

where W: Writer + Fallible,

Serializes the header into the specified writer.

Errors

Returns Err if writing to the given writer fails.

pub fn write<W>(&self, writer: &mut W) -> Result<(), <W as Fallible>::Error>

where W: Writer + Fallible,

Serializes the header and contents into the specified writer.

Errors

Returns Err if writing to the given writer fails.

Trait Implementations

impl<'a> Clone for VersionedBytes<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for VersionedBytes<'a>

impl<'a> Debug for VersionedBytes<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for VersionedBytes<'a>

impl<'a> Hash for VersionedBytes<'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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for VersionedBytes<'a>

fn cmp(&self, other: &VersionedBytes<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for VersionedBytes<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> PartialOrd for VersionedBytes<'a>

fn partial_cmp(&self, other: &VersionedBytes<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralPartialEq for VersionedBytes<'a>