Skip to main content

DeviceEvent

Struct DeviceEvent 

Source
#[non_exhaustive]
pub struct DeviceEvent { pub lane: Option<LaneKey>, pub edge: Edge, pub detail: String, }
Expand description

Something the medium wants to say when nobody is calling Medium::send.

The gap #51 names: every DeviceError is the return value of a data-path call, so a radio that loses registration, overheats, or drops off the bus is silent until the next transmission — which on a store-and-forward link may be an hour away, and on a dead one is never.

A plain struct rather than a channel, and that is the whole reason this works. modem-device has three dependencies — async-trait, thiserror, optional serde — and no tokio. Putting a watch::Receiver or a broadcast::Receiver on the trait would drag a runtime into a crate whose entire job is to be the seam, to obtain a channel type. An async fn mirroring Medium::recv needs nothing, is dyn-compatible through the async-trait already here, and has a default whose meaning is exactly “this medium never says anything”.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§lane: Option<LaneKey>

The lane it concerns, if it concerns one.

None for a device-wide condition — registration lost, over temperature, duty-cycle budget exhausted — which is most of them.

§edge: Edge

Whether this is the medium becoming unhappy or becoming happy again.

Edge-triggered by contract. A backend that repeated Raised while a condition persisted would produce a stream no rate declaration could honestly cover, and the consumer’s job is to publish these, not to deduplicate somebody else’s.

§detail: String

The device’s own words.

Carried verbatim to the management plane, which is the point: until #51 a DeviceError::Device(String) reached a warn! and was discarded, so +CME ERROR 3 — the one thing that says what is actually wrong — never left the process.

Implementations§

Source§

impl DeviceEvent

Source

pub fn raised(detail: impl Into<String>) -> Self

A condition beginning.

Source

pub fn cleared(detail: impl Into<String>) -> Self

A condition ending.

Source

pub fn on_lane(self, lane: LaneKey) -> Self

Attribute this event to one lane.

Trait Implementations§

Source§

impl Clone for DeviceEvent

Source§

fn clone(&self) -> Self

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 DeviceEvent

Source§

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

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

impl Eq for DeviceEvent

Source§

impl PartialEq for DeviceEvent

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DeviceEvent

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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 = !

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.