Enum VarKey

pub enum VarKey {
    Key1(Key1),
    Key2(Key2),
    Key4(Key4),
    Key8(Key),
}

A variably sized header Key

NOTE: We DO NOT impl Serialize/Deserialize for this type because we use non-postcard-compatible format (externally tagged) on the wire.

NOTE: VarKey implements PartialEq by reducing two VarKeys down to the smaller of the two forms, and checking whether they match. This allows a key in 8-byte form to be compared to a key in 1, 2, or 4-byte form for equality.

Variants

Key1(Key1)

A one byte key

Key2(Key2)

A two byte key

Key4(Key4)

A four byte key

Key8(Key)

An eight byte key

Implementations

impl VarKey

pub fn shrink_to(&mut self, kind: VarKeyKind)

Keys can not be reaised, but instead only shrunk.

This method will shrink to the requested length if that length is smaller than the current representation, or if the requested length is the same or larger than the current representation, it will be kept unchanged

pub fn kind(&self) -> VarKeyKind

The current kind/length of the key

Trait Implementations

impl Clone for VarKey

fn clone(&self) -> VarKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarKey

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

Formats the value using the given formatter.

impl PartialEq for VarKey

We implement PartialEq MANUALLY for VarKey, because keys of different lengths SHOULD compare as equal.

fn eq(&self, other: &Self) -> 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 VarKey