Skip to main content

ReachabilitySource

Enum ReachabilitySource 

Source
#[non_exhaustive]
pub enum ReachabilitySource { Probe, Session, Unknown, }
Expand description

WHICH producer emitted a StreamFrame::Reachability (#150). The two say different things about the world and license different user-facing statements, and until API 1.30 the frame carried no way to tell them apart.

Advisory attribution, never an authz input: it says where an observation CAME FROM, never who a peer is.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Probe

A probe completed — a fresh throwaway dial (status/subscribe refreshing a stale entry). It describes that dial and nothing else: a Probe frame saying Relay does NOT mean any live connection is relayed.

§

Session

A live session’s selected path changed under it (#92 item 2). This is a claim about the link a peer’s traffic is actually on — the frame an embedder wants when warning that a call which WAS direct silently is not any more.

§

Unknown

The daemon did not say (api_minor < 30), or it named a producer this client predates.

The DEFAULT, deliberately — see StreamFrame::Reachability. Like PeerPath::Unknown it means “we do not know” and must never be collapsed into either confident case.

Trait Implementations§

Source§

impl Clone for ReachabilitySource

Source§

fn clone(&self) -> ReachabilitySource

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ReachabilitySource

Source§

impl Debug for ReachabilitySource

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReachabilitySource

Source§

fn default() -> ReachabilitySource

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ReachabilitySource

Hand-written so an unrecognized producer lands on ReachabilitySource::Unknown instead of failing the whole frame. PeerPath gets this from #[serde(other)], which serde allows only on an internally/adjacently tagged enum; this one is a plain string, so it is spelled out. The stakes are the same as there: without it, adding a third producer later would break every Reachability frame an older pinned client reads, not just the new field.

It accepts ANY input, not just an unrecognized string — null, a number, an object all read as Unknown. #[serde(default)] covers an ABSENT key and nothing else, so without this a proxy or non-Rust daemon that normalizes optional fields to null would fail every reachability frame while this module’s doc promised the field could not break a parse. A degraded attribution is the fail-safe: Unknown already means “we do not know”, which is exactly true of a value we could not read.

Source§

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ReachabilitySource

Source§

impl PartialEq for ReachabilitySource

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ReachabilitySource

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ReachabilitySource

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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> ToOwned for T
where T: Clone,

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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