Skip to main content

Event

antenna_client_shared

Enum Event

pub enum Event<Msg: UserMsgPayload> {
    Connected(NoArgCallback),
    UserMessage(MessageCallback<Msg>),
    Disconnected(NoArgCallback),
    PeerConnected(PeerCallback),
    PeerDisconnected(PeerCallback),
    PeerLost(PeerCallback),
    Available(NoArgCallback),
    Unavailable(NoArgCallback),
}

Expand description

User-facing subscription — pairs an event kind with the callback to run.

Pass to Peer::subscribe to register; the returned id is what Peer::unsubscribe consumes.

Variants§

Connected(NoArgCallback)

Local node connected to its first peer.

UserMessage(MessageCallback<Msg>)

Message arrived from a remote peer.

Disconnected(NoArgCallback)

Local node left the mesh.

PeerConnected(PeerCallback)

Remote peer joined the mesh.

PeerDisconnected(PeerCallback)

Remote peer left gracefully.

PeerLost(PeerCallback)

Remote peer dropped abruptly (reconnect will be attempted).

Available(NoArgCallback)

All in-progress relay handshakes settled — node is fully meshed.

Unavailable(NoArgCallback)

At least one relay handshake is in progress, or no peers connected.

Auto Trait Implementations§

impl<Msg> Freeze for Event<Msg>

impl<Msg> !RefUnwindSafe for Event<Msg>

impl<Msg> Send for Event<Msg>

impl<Msg> Sync for Event<Msg>

impl<Msg> Unpin for Event<Msg>

impl<Msg> UnsafeUnpin for Event<Msg>

impl<Msg> !UnwindSafe for Event<Msg>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

type Output = T

Should always be Self

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more

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

fn vzip(self) -> V