Skip to main content

Memory

Struct Memory 

Source
pub struct Memory { /* private fields */ }
Available on crate feature connect-server only.
Expand description

A Store that keeps everything in memory.

Correct, and suitable for a test or a device that re-pairs on every boot. Anything that must survive a power cut needs a real one.

Implementations§

Source§

impl Memory

Source

pub fn new() -> Arc<Self> ⓘ

An empty store.

Source

pub fn add_node(&self, node: NodeDescription, alias: Option<NodeIdAlias>)

Add one of our own nodes.

Source

pub fn open_for_pairing(&self, node: NodeId, token: PairingToken)

Open one of our nodes for pairing with a static token — the one printed on the device, valid until close_pairing or a completed pairing.

Source

pub fn open_for_pairing_until( &self, node: NodeId, token: PairingToken, expires: Timestamp, )

Open one of our nodes for pairing with a dynamic token, valid for DYNAMIC_TOKEN_LIFETIME from now — what pressing the button on a device with a display does.

Source

pub fn open_for_pairing_dynamic( &self, node: NodeId, token: PairingToken, now: Timestamp, )

open_for_pairing_until now plus the recommended five minutes.

Source

pub fn close_pairing(&self, node: NodeId)

Stop accepting pairings for a node.

Trait Implementations§

Source§

impl Debug for Memory

Source§

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

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

impl Default for Memory

Source§

fn default() -> Self

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

impl Store for Memory

Source§

fn pairing_token(&self, node: NodeId, now: Timestamp) -> Option<PairingToken>

The pairing token currently accepting a pairing for one of our nodes, if any. Read more
Source§

fn resolve_alias(&self, alias: &NodeIdAlias) -> Option<NodeId>

Which of our nodes an alias names.
Source§

fn sole_node(&self) -> Option<NodeId>

Our node, when the endpoint hosts exactly one and the client named none.
Source§

fn node(&self, node: NodeId) -> Option<NodeDescription>

Everything about one of our nodes.
Source§

fn nodes(&self) -> Vec<(NodeDescription, Option<NodeIdAlias>)>

Every node this endpoint hosts, for GET /v1/nodes.
Source§

fn pair(&self, paired: PairedNode)

Record a completed pairing, replacing any earlier one under the same key, and consume the pairing token that opened it.
Source§

fn paired(&self, key: PairingKey) -> Option<PairedNode>

One pairing.
Source§

fn pairings_of(&self, local: NodeId) -> Vec<PairingKey>

Every pairing one of our own nodes has, revoked ones excluded. Read more
Source§

fn set_tokens(&self, key: PairingKey, tokens: TokenStore)

Replace a pairing’s tokens after a rotation.
Source§

fn revoke(&self, key: PairingKey)

Mark a pairing unpaired by this endpoint, keeping it until the peer has been told.
Source§

fn unpair(&self, key: PairingKey)

Forget a pairing.
Source§

fn pairing_for_token(&self, token: &AccessToken) -> Option<PairingKey>

Which pairing a presented access token belongs to, revoked pairings excluded.

Auto Trait Implementations§

§

impl !Freeze for Memory

§

impl Forget for Memory

§

impl Move for Memory

§

impl RefUnwindSafe for Memory

§

impl Send for Memory

§

impl Sync for Memory

§

impl Unpin for Memory

§

impl UnsafeUnpin for Memory

§

impl UnwindSafe for Memory

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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