Skip to main content

Machine

Struct Machine 

Source
pub struct Machine {
    session_known: bool,
    email: Option<String>,
    link: Link,
    pull_errors: BTreeMap<String, String>,
    status: MuxBusDeliveryStatus,
    paused_since_ms: Option<i64>,
    pause_noted: bool,
    sign_in_notified: bool,
}
Expand description

Cloud delivery’s state over time, and the episodes that drive the notification and the agents’ notes.

Fields§

§session_known: bool§email: Option<String>§link: Link§pull_errors: BTreeMap<String, String>

Agents whose REST pull is failing (agent → reason) though the WebSocket may be open: their messages can’t be fetched, so that is not connected either. An agent’s entry clears when its own pull answers, not another agent’s.

§status: MuxBusDeliveryStatus§paused_since_ms: Option<i64>

When the current pause began; open until delivery is connected again. A sign-out ends one only if the agents weren’t told about it.

§pause_noted: bool

The agents were told about the current pause.

§sign_in_notified: bool

The current needs-sign-in episode has had its notification.

Implementations§

Source§

impl Machine

Source

pub fn new(now_ms: i64) -> Self

Source

pub fn status(&self) -> &MuxBusDeliveryStatus

Source

pub fn saw_session( &mut self, email: Option<String>, broker: Option<&CredentialState>, now_ms: i64, ) -> Vec<Effect>

The subscriber found a sign-in to use (email when it could read one).

Source

pub fn fresh_sign_in( &mut self, email: Option<String>, now_ms: i64, ) -> Vec<Effect>

The user just signed in (muxbus.login saved it): connecting, whatever the broker still says about the sign-in this one replaces.

Source

pub fn signed_out(&mut self, now_ms: i64) -> Vec<Effect>

The user signed out on purpose: not a lost sign-in.

Source

pub fn relay_answered( &mut self, agent: &str, broker: Option<&CredentialState>, now_ms: i64, ) -> Vec<Effect>

The relay answered agent’s pull: delivery is healthy as of now_ms.

Source

pub fn pull_failed( &mut self, agent: &str, reason: String, broker: Option<&CredentialState>, now_ms: i64, ) -> Vec<Effect>

agent’s pull (fetch or claim) got no usable answer from the relay.

Source

pub fn keep_pull_errors_of(&mut self, agents: &[String])

Forget pull failures of agents no longer subscribed: they won’t pull again to clear them.

Source

pub fn tick( &mut self, broker: Option<&CredentialState>, now_ms: i64, ) -> Vec<Effect>

Re-derive (the broker may have moved on its own) and release the pause note once it is due.

Source

fn update( &mut self, broker: Option<&CredentialState>, now_ms: i64, ) -> Vec<Effect>

Trait Implementations§

Source§

impl Clone for Machine

Source§

fn clone(&self) -> Machine

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 Machine

Source§

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

Formats the value using the given formatter. Read more

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
§

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

§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

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

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

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

Convert &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)

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

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

§

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

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

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

§

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
§

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

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