Enum nachricht::Header

pub enum Header {
    Null,
    True,
    False,
    F32,
    F64,
    Bin(usize),
    Pos(u64),
    Neg(u64),
    Bag(usize),
    Str(usize),
    Sym(usize),
    Key(usize),
    Ref(usize),
}

Variants

Null

Also known as unit or nil

True

The boolean value true

False

The boolean value false

F32

The following four bytes contain an IEEE-754 32-bit floating point number

F64

The following eight bytes contain an IEEE-754 64-bit floating point number

Bin(usize)

Tuple Fields

0: usize

The value describes the length of a following byte array. Note that this code also contains the five fixed length values.

Pos(u64)

Tuple Fields

0: u64

The value describes a postive integer fitting into an u64

Neg(u64)

Tuple Fields

0: u64

The value describes a negative integer whose negative fits into an u64

Bag(usize)

Tuple Fields

0: usize

The value describes the length in fields of a container. the fields follow the header immediately.

Str(usize)

Tuple Fields

0: usize

The value describes the length in bytes of a following unicode string

Sym(usize)

Tuple Fields

0: usize

A symbol has the same semantics as a string except that it gets pushed into the symbol table and can be referenced from there

Key(usize)

Tuple Fields

0: usize

The value describes the length in bytes of a following key value. This in itself does not define a field and thus has to immediately followed by another header whose field will be named by this key.

Ref(usize)

Tuple Fields

0: usize

A reference into the symbol table. This could resolve to either a symbol (which itself resolve to a string) or a key.

Implementations

impl Header

pub fn name(&self) -> &'static str

Returns the mnemonic of the header. This is useful for error messages.

pub fn encode<W: Write>(&self, w: &mut W) -> Result<usize, EncodeError>

Returns the number of written bytes

pub fn decode<B: ?Sized + AsRef<[u8]>>(
    buf: &B
) -> Result<(Self, usize), DecodeError>

Returns the decoded header and the number of consumed bytes

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy 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<Header> for Header

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

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

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

This method tests for !=.

impl Copy for Header

impl StructuralPartialEq for Header