Skip to main content

RecentPeers

Struct RecentPeers 

Source
pub struct RecentPeers {
    pub version: u32,
    pub local_npub: String,
    pub scope: String,
    pub peers: BTreeMap<String, RecentPeer>,
}
Expand description

Store-agnostic version-1 recent-peer document.

The serialized object contains exactly version, local_npub, scope, and peers. Applications choose where and how to persist that JSON.

Fields§

§version: u32§local_npub: String§scope: String§peers: BTreeMap<String, RecentPeer>

Implementations§

Source§

impl RecentPeers

Source

pub fn new( local_npub: impl Into<String>, scope: impl Into<String>, ) -> Result<RecentPeers, RecentPeersError>

Create an empty version-1 cache for one local identity and app scope.

Source

pub fn from_json( json: &str, expected_local_npub: &str, expected_scope: &str, ) -> Result<RecentPeers, RecentPeersError>

Strictly decode and validate a cache for the expected identity/scope.

Unknown fields, unknown transports, wrong versions, invalid identities, unsafe endpoints, and documents exceeding the schema limits are rejected. Identity and scope binding prevents one app or local key from accidentally consuming another’s routing memory.

Source

pub fn to_json(&self) -> Result<String, RecentPeersError>

Validate and encode the canonical compact version-1 JSON document.

Source

pub fn to_json_pretty(&self) -> Result<String, RecentPeersError>

Validate and encode an indented version-1 JSON document.

Source

pub fn local_npub(&self) -> &str

Local identity to which this routing cache is bound.

Source

pub fn scope(&self) -> &str

Application discovery scope to which this routing cache is bound.

Source

pub fn validate(&self) -> Result<(), RecentPeersError>

Validate all schema invariants without decoding or encoding JSON.

Source

pub fn observe_authenticated_peer( &mut self, peer: &FipsEndpointPeer, authenticated_at_ms: u64, ) -> Result<bool, RecentPeersError>

Record one currently authenticated endpoint snapshot.

A connected peer’s identity is retained regardless of transport. Only FipsEndpointPeer::authenticated_udp_restart_addr can add a restart endpoint. A disconnected status/retry entry is ignored because it is not fresh authentication evidence.

Returns true only when the cache contents changed.

Source

pub fn prune(&mut self, now_ms: u64, ttl_ms: u64)

Remove identity and endpoint observations older than ttl_ms.

Identity-only records are intentionally retained for the same TTL as routed records. Future timestamps survive clock rollback by using saturating age arithmetic.

Source

pub fn merge_into_peer_configs(&self, peer_configs: &mut [PeerConfig]) -> usize

Merge cached routes into already-authorized peer configurations.

This method cannot create membership: it only mutates entries in the supplied slice and never calls crate::endpoint::FipsEndpoint::update_peers. Applications remain responsible for deciding which peers belong in that slice. Cached addresses use authenticated provenance and preserve their observation timestamp for retry ranking.

Returns the number of addresses added or refreshed.

Trait Implementations§

Source§

impl Clone for RecentPeers

Source§

fn clone(&self) -> RecentPeers

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 Debug for RecentPeers

Source§

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

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

impl<'de> Deserialize<'de> for RecentPeers

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<RecentPeers, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

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

impl Eq for RecentPeers

Source§

impl PartialEq for RecentPeers

Source§

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

Source§

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

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

impl StructuralPartialEq for RecentPeers

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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