Enum tor_netdoc::doc::netstatus::ConsensusFlavor

#[non_exhaustive]
pub enum ConsensusFlavor {
    Microdesc,
    Ns,
}

A recognized ‘flavor’ of consensus document.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Microdesc

A “microdesc”-flavored consensus. This is the one that clients and relays use today.

Ns

A “networkstatus”-flavored consensus. It’s used for historical and network-health purposes. Instead of listing microdescriptor digests, it lists digests of full relay descriptors.

Implementations

impl ConsensusFlavor

pub fn name(&self) -> &'static str

Return the name of this consensus flavor.

pub fn from_opt_name(name: Option<&str>) -> Result<Self>

Try to find the flavor whose name is name.

For historical reasons, an unnamed flavor indicates an “Ns” document.

Trait Implementations

impl Clone for ConsensusFlavor

fn clone(&self) -> ConsensusFlavor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConsensusFlavor

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

Formats the value using the given formatter.

impl Hash for ConsensusFlavor

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,

Feeds a slice of this type into the given Hasher.

impl Ord for ConsensusFlavor

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ConsensusFlavor> for ConsensusFlavor

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

fn partial_cmp(&self, other: &ConsensusFlavor) -> 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 Copy for ConsensusFlavor

impl Eq for ConsensusFlavor

impl StructuralEq for ConsensusFlavor

impl StructuralPartialEq for ConsensusFlavor