RouterStatus

tor_netdoc::doc::netstatus::plain

Struct RouterStatus

#[non_exhaustive]pub struct RouterStatus {
    pub nickname: Nickname,
    pub identity: RsaIdentity,
    pub addrs: Vec<SocketAddr>,
    pub doc_digest: RdDigest,
    pub flags: RelayFlags,
    pub version: Option<Version>,
    pub protos: Arc<Protocols>,
    pub weight: RelayWeight,
}

Available on crate feature plain-consensus only.

Expand description

A single relay’s status, in a network status document.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§nickname: Nickname

Available on crate feature dangerous-expose-struct-fields only.

The nickname for this relay.

Nicknames can be used for convenience purpose, but no more: there is no mechanism to enforce their uniqueness.

§identity: RsaIdentity

Available on crate feature dangerous-expose-struct-fields only.

Fingerprint of the old-style RSA identity for this relay.

§addrs: Vec<SocketAddr>

Available on crate feature dangerous-expose-struct-fields only.

A list of address:port values where this relay can be reached.

§doc_digest: RdDigest

Available on crate feature dangerous-expose-struct-fields only.

Digest of the document for this relay.

§flags: RelayFlags

Available on crate feature dangerous-expose-struct-fields only.

Flags applied by the authorities to this relay.

§version: Option<Version>

Available on crate feature dangerous-expose-struct-fields only.

Version of the software that this relay is running.

§protos: Arc<Protocols>

Available on crate feature dangerous-expose-struct-fields only.

List of subprotocol versions supported by this relay.

§weight: RelayWeight

Available on crate feature dangerous-expose-struct-fields only.

Information about how to weight this relay when choosing a relay at random.

Implementations§

impl RouterStatus

pub fn orport_addrs(&self) -> impl Iterator<Item = &SocketAddr>

Return an iterator of ORPort addresses for this routerstatus

pub fn weight(&self) -> &RelayWeight

Return the declared weight of this routerstatus in the directory.

pub fn addrs(&self) -> &[SocketAddr]

Return the ORPort addresses of this routerstatus

pub fn protovers(&self) -> &Protocols

Return the protovers that this routerstatus says it implements.

pub fn nickname(&self) -> &str

Return the nickname of this routerstatus.

pub fn flags(&self) -> &RelayFlags

Return the relay flags of this routerstatus.

pub fn version(&self) -> Option<&Version>

Return the version of this routerstatus.

pub fn ed25519_id_is_usable(&self) -> bool

Return true if the ed25519 identity on this relay reflects a true consensus among the authorities.

pub fn is_flagged_bad_exit(&self) -> bool

Return true if this routerstatus is listed with the BadExit flag.

pub fn is_flagged_v2dir(&self) -> bool

Return true if this routerstatus is listed with the v2dir flag.

pub fn is_flagged_exit(&self) -> bool

Return true if this routerstatus is listed with the Exit flag.

pub fn is_flagged_guard(&self) -> bool

Return true if this routerstatus is listed with the Guard flag.

pub fn is_flagged_hsdir(&self) -> bool

Return true if this routerstatus is listed with the HSDir flag.

pub fn is_flagged_stable(&self) -> bool

Return true if this routerstatus is listed with the Stable flag.

pub fn is_flagged_fast(&self) -> bool

Return true if this routerstatus is listed with the Fast flag.

pub fn is_flagged_middle_only(&self) -> bool

Return true if this routerstatus is listed with the MiddleOnly flag.

impl RouterStatus

pub fn rsa_identity(&self) -> &RsaIdentity

Return RSA identity for the relay described by this RouterStatus

pub fn doc_digest(&self) -> &DocDigest

Return the digest of the document identified by this routerstatus.

impl RouterStatus

pub fn rd_digest(&self) -> &DocDigest

Return the expected router descriptor digest for this routerstatus

Trait Implementations§

impl Clone for RouterStatus

fn clone(&self) -> RouterStatus

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for RouterStatus

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for RouterStatus

impl RefUnwindSafe for RouterStatus

impl Send for RouterStatus

impl Sync for RouterStatus

impl Unpin for RouterStatus

impl UnwindSafe for RouterStatus

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

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

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,