Struct sn_routing::Prefix

pub struct Prefix { /* fields omitted */ }

A section prefix, i.e. a sequence of bits specifying the part of the network’s name space consisting of all names that start with this sequence.

Implementations

impl Prefix

pub fn new(bit_count: usize, name: XorName) -> Prefix

Creates a new Prefix with the first bit_count bits of name. Insignificant bits are all set to 0.

pub fn name(&self) -> XorName

Returns the name of this prefix.

pub fn pushed(self, bit: bool) -> Prefix

Returns self with an appended bit: 0 if bit is false, and 1 if bit is true. If self.bit_count is already at the maximum for this type, then an unmodified copy of self is returned.

pub fn popped(self) -> Prefix

Returns a prefix copying the first bitcount() - 1 bits from self, or self if it is already empty.

pub fn bit_count(&self) -> usize

Returns the number of bits in the prefix.

pub fn is_empty(&self) -> bool

Returns true if this is the empty prefix, with no bits.

pub fn is_compatible(&self, other: &Prefix) -> bool

Returns true if self is a prefix of other or vice versa.

pub fn is_extension_of(&self, other: &Prefix) -> bool

Returns true if other is compatible but strictly shorter than self.

pub fn is_neighbour(&self, other: &Prefix) -> bool

Returns true if the other prefix differs in exactly one bit from this one.

pub fn common_prefix(&self, name: &XorName) -> usize

Returns the number of common leading bits with the input name, capped with prefix length.

pub fn matches(&self, name: &XorName) -> bool

Returns true if this is a prefix of the given name.

pub fn cmp_distance(&self, other: &Prefix, target: &XorName) -> Ordering

Compares the distance of self and other to target. Returns Less if self is closer, Greater if other is closer, and compares the prefix directly if of equal distance (this is to make sorting deterministic).

pub fn cmp_breadth_first(&self, other: &Prefix) -> Ordering

Compares the prefixes using breadth-first order. That is, shorter prefixes are ordered before longer. This is in contrast with the default Ord impl of Prefix which uses depth-first order.

pub fn lower_bound(&self) -> XorName

Returns the smallest name matching the prefix

pub fn upper_bound(&self) -> XorName

Returns the largest name matching the prefix

pub fn range_inclusive(&self) -> RangeInclusive<XorName>

Inclusive range from lower_bound to upper_bound

pub fn is_covered_by<'a, I>(&self, prefixes: I) -> bool where
    I: IntoIterator<Item = &'a Prefix> + Clone, 

Returns whether the namespace defined by self is covered by prefixes in the prefixes set

pub fn with_flipped_bit(&self, i: u8) -> Prefix

Returns the neighbouring prefix differing in the i-th bit If i is larger than our bit count, self is returned

pub fn substituted_in(&self, name: XorName) -> XorName

Returns the given name with first bits replaced by self

pub fn sibling(&self) -> Prefix

Returns the same prefix, with the last bit flipped, or unchanged, if empty.

pub fn ancestor(&self, bit_count: u8) -> Prefix

Returns the ancestors of this prefix that has the given bit count.

Panics

Panics if bit_count is not less than the bit count of this prefix.

pub fn ancestors(&self) -> Ancestors

Returns an iterator that yields all ancestors of this prefix.

Trait Implementations

impl Binary for Prefix

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

Formats the value using the given formatter.

impl Clone for Prefix

pub fn clone(&self) -> Prefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Prefix

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

Formats the value using the given formatter.

impl Default for Prefix

pub fn default() -> Prefix

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Prefix

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

Deserialize this value from the given Serde deserializer.

impl FromStr for Prefix

type Err = FromStrError

The associated error which can be returned from parsing.

pub fn from_str(bits: &str) -> Result<Prefix, <Prefix as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Prefix

pub 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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Prefix

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Prefix> for Prefix

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Prefix> for Prefix

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 Prefix

pub 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 Copy for Prefix

impl Eq for Prefix

impl StructuralEq for Prefix