Struct akd::NodeLabel

pub struct NodeLabel {
    pub label_val: [u8; 32],
    pub label_len: u32,
}

Represents the label of a AKD node

Fields

label_val: [u8; 32]

Stores a binary string as a 32-byte array of u8s

label_len: u32

len keeps track of how long the binary string is in bits

Implementations

impl NodeLabel

pub fn hash(&self) -> [u8; 32]

Hash a NodeLabel into a digest, length-prefixing the label’s value

pub fn get_longest_common_prefix(&self, other: NodeLabel) -> NodeLabel

Takes as input a pointer to the caller and another NodeLabel, returns a NodeLabel that is the longest common prefix of the two.

pub fn get_prefix(&self, len: u32) -> NodeLabel

Returns the prefix of a specified length, and the entire value on an out of range length

pub fn root() -> NodeLabel

Creates a new NodeLabel representing the root.

pub fn new(val: [u8; 32], len: u32) -> NodeLabel

Creates a new NodeLabel with the given value and len.

pub fn get_len(&self) -> u32

Gets the length of a NodeLabel.

pub fn get_val(&self) -> [u8; 32]

Gets the value of a NodeLabel.

pub fn get_sibling_prefix(&self, len: u32) -> NodeLabel

The sibling of a node in a binary tree has the same label as its sibling except its last bit is flipped (e.g., 000 and 001 are siblings). This function returns the sibling prefix of a specified length. The rest of the node label after the flipped bit is padded with zeroes. For instance, 010100 (length = 6) with sibling prefix length = 3 is 01[1]000 (length = 3) – [bit] denoting flipped bit.

pub fn get_longest_common_prefix_and_dirs(
    &self,
    other: NodeLabel
) -> (NodeLabel, Option<usize>, Option<usize>)

Takes as input a pointer to self, another NodeLabel and returns the tuple representing:

• the longest common prefix,
• the direction, with respect to the longest common prefix, of other,
• the direction, with respect to the longest common prefix, of self. If either the node itself, or other is the longest common prefix, the direction of the longest common prefix node is None.

pub fn get_dir(&self, other: NodeLabel) -> Option<usize>

Gets the direction of other with respect to self, if self is a prefix of other. If self is not a prefix of other, then returns None.

Trait Implementations

impl Clone for NodeLabel

fn clone(&self) -> NodeLabel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeLabel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeLabel

fn deserialize<__D>(
    __deserializer: __D
) -> Result<NodeLabel, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NodeLabel

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

Formats the value using the given formatter.

impl From<&NodeLabel> for NodeLabel

fn from(input: &NodeLabel) -> NodeLabel

Converts to this type from the input type.

impl Hash for NodeLabel

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NodeLabel

fn cmp(&self, other: &NodeLabel) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NodeLabel> for NodeLabel

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

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

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

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

impl PartialOrd<NodeLabel> for NodeLabel

fn partial_cmp(&self, other: &NodeLabel) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NodeLabel

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl SizeOf for NodeLabel

fn size_of(&self) -> usize

Retrieve the in-memory size of a structure

impl TryFrom<&NodeLabel> for NodeLabel

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(
    input: &NodeLabel
) -> Result<NodeLabel, <NodeLabel as TryFrom<&NodeLabel>>::Error>

Performs the conversion.

impl Copy for NodeLabel

impl Eq for NodeLabel

impl StructuralEq for NodeLabel

impl StructuralPartialEq for NodeLabel