Struct Symbol

pub struct Symbol(/* private fields */);

Symbols are small (up to 8-byte) segments of strings, stored in a Compressor and identified by an 8-bit code.

Implementations

impl Symbol

pub const ZERO: Self

Zero value for Symbol.

pub fn from_slice(slice: &[u8; 8]) -> Self

Constructor for a Symbol from an 8-element byte slice.

pub fn from_u8(value: u8) -> Self

Create a new single-byte symbol

impl Symbol

pub fn len(self) -> usize

Calculate the length of the symbol in bytes. Always a value between 1 and 8.

Each symbol has the capacity to hold up to 8 bytes of data, but the symbols can contain fewer bytes, padded with 0x00. There is a special case of a symbol that holds the byte 0x00. In that case, the symbol contains 0x0000000000000000 but we want to interpret that as a one-byte symbol containing 0x00.

pub fn first_byte(self) -> u8

Get the first byte of the symbol as a u8.

If the symbol is empty, this will return the zero byte.

pub fn first2(self) -> u16

Get the first two bytes of the symbol as a u16.

If the Symbol is one or zero bytes, this will return 0u16.

pub fn first3(self) -> u64

Get the first three bytes of the symbol as a u64.

If the Symbol is one or zero bytes, this will return 0u64.

pub fn concat(self, other: Self) -> Self

Return a new Symbol by logically concatenating ourselves with another Symbol.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Copy for Symbol