Struct HsDirIndex

pub(crate) struct HsDirIndex([u8; 32]);

Available on crate feature hs-common only.

A sort key determining a position in the onion service directory ring.

This is either the sort key of a given relay at a given time period, or the sort key for a probing position for a given onion service id at a given time.

The specification calls this an “index” but HsDirIndex is a key-length sized, apparently-random, value, which determines the ordering of relays on the ring. It is not the position number (ie, not a dense index starting at 0).

Note that this is not an index into any array; it is instead an index into a space of possible values in a (virtual!) ring of 2^256 elements.

Tuple Fields

0: [u8; 32]

Trait Implementations

impl AsRef<[u8; 32]> for HsDirIndex

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HsDirIndex

fn clone(&self) -> HsDirIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HsDirIndex

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

Formats the value using the given formatter.

impl Hash for HsDirIndex

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

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 HsDirIndex

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HsDirIndex

fn eq(&self, other: &HsDirIndex) -> 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 PartialOrd for HsDirIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for HsDirIndex

impl Eq for HsDirIndex

impl StructuralPartialEq for HsDirIndex