Struct Header 

pub struct Header {
    pub version: u16,
}

Available on crate feature alloc only.

A parsed, supported journal file header.

Fields

version: u16

The on-disk format version.

Implementations

impl Header

pub const LEN: usize = 8usize

Byte length of a journal file header: magic(4) || version_be(2) || reserved(2), written once before any frames.

pub const fn current() -> Self

The header this crate writes for new journals.

pub const fn is_current(&self) -> bool

Whether this header names the version this crate writes. A file with an older version must be migrated before anything is appended to it.

pub fn encode_to_vec(&self, out: &mut Vec<u8>)

Encodes this header into out.

pub fn decode(bytes: &[u8]) -> Result<Self, HeaderError>

Decodes the header at the start of bytes.

Errors

Returns HeaderError on a short, mismatched, or unsupported header.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl PartialEq for Header

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Header

impl Eq for Header

impl StructuralPartialEq for Header