Struct fress::symbol::guide::Guide

pub struct Guide {
    pub hash: u32,
    pub solidus: u32,
    pub count: u32,
    pub prism: AnchoredLine,
    pub root: AnchoredLine,
}

The Guide structure is hydrated from its in-memory representation, 64 bits in length. The top 32 bits contain the hash, the bottom 32 bits contain the length in bytes and the position of the prefix separating solidus. A position of 0 means no prefix. Top 32 bits [ Hash (32) ] Bottom bits [ Solidus (8) | Count (8) ]

Fields

hash: u32

solidus: u32

count: u32

prism: AnchoredLine

root: AnchoredLine

Implementations

impl Guide

pub fn units() -> u32

pub fn segment(&self) -> Segment

pub fn set_hash(self, hash: u32) -> Guide

pub fn clear_hash(self) -> Guide

pub fn has_hash(&self) -> bool

pub fn reroot(self) -> Guide

pub fn hydrate(prism: AnchoredLine) -> Guide

pub fn hydrate_top_bot(prism: AnchoredLine, top: u32, bot: u32) -> Guide

pub fn new(prism: AnchoredLine, solidus_position: u32, byte_count: u32) -> Guide

pub fn store_at(&self, prism: AnchoredLine)

pub fn store(self) -> Guide

pub fn store_hash(self) -> Guide

pub fn byte_slice(&self) -> &mut [u8]

pub fn str(&self) -> &mut str

pub fn set_count(self, count: u32) -> Guide

Trait Implementations

impl Clone for Guide

fn clone(&self) -> Guide

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Guide

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

Formats the value using the given formatter.

impl Copy for Guide