Struct tor_netdoc::doc::netstatus::Consensus

source · [−]

pub struct Consensus<RS> { /* private fields */ }

Expand description

A single microdescriptor consensus netstatus

TODO: This should possibly turn into a parameterized type, to represent votes and ns consensuses.

Implementations

source

impl<RS> Consensus<RS>

source

pub fn lifetime(&self) -> &Lifetime

Return the Lifetime for this consensus.

source

pub fn relays(&self) -> &[RS]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Return a slice of all the routerstatus entries in this consensus.

source

pub fn bandwidth_weights(&self) -> &NetParams<i32>

Return a mapping from keywords to integers representing how to weight different kinds of relays in different path positions.

source

pub fn params(&self) -> &NetParams<i32>

Return the map of network parameters that this consensus advertises.

source

impl<RS: RouterStatus + ParseRouterStatus> Consensus<RS>

source

pub fn parse(s: &str) -> Result<(&str, &str, UncheckedConsensus<RS>)>

Try to parse a single networkstatus document from a string.

Trait Implementations

source

impl<RS: Clone> Clone for Consensus<RS>

source

fn clone(&self) -> Consensus<RS>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<RS: Debug> Debug for Consensus<RS>

source

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

Formats the value using the given formatter. Read more

source

impl<RS> ExternallySigned<Consensus<RS>> for UnvalidatedConsensus<RS>

type Key = [AuthCert ]

The type of the public key object. Read more

type KeyHint = Vec<AuthCertKeyIds, Global>

A type that describes what keys are missing for this object.

type Error = Error

An error type that’s returned when the object is not well-signed.

source

fn key_is_correct(&self, k: &Self::Key) -> Result<(), Self::KeyHint>

Check whether k is the right key for this object. If not, return an error describing what key would be right. Read more

source

fn is_well_signed(&self, k: &Self::Key) -> Result<(), Self::Error>

Check the signature on this object

source

fn dangerously_assume_wellsigned(self) -> Consensus<RS>

Unwrap this object without checking any signatures on it.

source

fn check_signature(self, k: &Self::Key) -> Result<T, Self::Error>

Unwrap this object if it’s correctly signed by a provided key.

Auto Trait Implementations

impl<RS> RefUnwindSafe for Consensus<RS> where
RS: RefUnwindSafe,

impl<RS> Send for Consensus<RS> where
RS: Send,

impl<RS> Sync for Consensus<RS> where
RS: Sync,

impl<RS> Unpin for Consensus<RS> where
RS: Unpin,

impl<RS> UnwindSafe for Consensus<RS> where
RS: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct tor_netdoc::doc::netstatus::Consensus

Implementations

impl<RS> Consensus<RS>

pub fn lifetime(&self) -> &Lifetime

pub fn relays(&self) -> &[RS]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn bandwidth_weights(&self) -> &NetParams<i32>

pub fn params(&self) -> &NetParams<i32>

impl<RS: RouterStatus + ParseRouterStatus> Consensus<RS>

pub fn parse(s: &str) -> Result<(&str, &str, UncheckedConsensus<RS>)>

Trait Implementations

impl<RS: Clone> Clone for Consensus<RS>

fn clone(&self) -> Consensus<RS>

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

impl<RS: Debug> Debug for Consensus<RS>

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

impl<RS> ExternallySigned<Consensus<RS>> for UnvalidatedConsensus<RS>

type Key = [AuthCert]

type KeyHint = Vec<AuthCertKeyIds, Global>

type Error = Error

fn key_is_correct(&self, k: &Self::Key) -> Result<(), Self::KeyHint>

fn is_well_signed(&self, k: &Self::Key) -> Result<(), Self::Error>

fn dangerously_assume_wellsigned(self) -> Consensus<RS>

fn check_signature(self, k: &Self::Key) -> Result<T, Self::Error>

Auto Trait Implementations

impl<RS> RefUnwindSafe for Consensus<RS> where RS: RefUnwindSafe,

impl<RS> Send for Consensus<RS> where RS: Send,

impl<RS> Sync for Consensus<RS> where RS: Sync,

impl<RS> Unpin for Consensus<RS> where RS: Unpin,

impl<RS> UnwindSafe for Consensus<RS> where RS: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn relays(&self) -> &[RS]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

type Key = [AuthCert ]

impl<RS> RefUnwindSafe for Consensus<RS> where
RS: RefUnwindSafe,

impl<RS> Send for Consensus<RS> where
RS: Send,

impl<RS> Sync for Consensus<RS> where
RS: Sync,

impl<RS> Unpin for Consensus<RS> where
RS: Unpin,

impl<RS> UnwindSafe for Consensus<RS> where
RS: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,