Skip to main content

Reading

Enum Reading 

Source
pub enum Reading {
    Values(Vec<(&'static str, bool)>),
    Unavailable(String),
}
Expand description

What an addon’s signals read at one moment.

§Why the daemon asks rather than the addon telling

Polled, not pushed, and the reasons are all about what happens when this interface crosses a process boundary — which FR-045 says it will.

A request/response call survives that move unchanged. A callback does not: it needs a reverse channel, and a reverse channel is precisely where a wedged addon becomes a wedged daemon, because something has to be waiting on it.

Polling also puts the rate limit on the side that suffers from getting it wrong. A pushing addon that reports a flapping signal thousands of times a second is a churn source the daemon can only damp after paying for it, and ADR-0011 is explicit that signal churn is flash wear rather than a slow link. A polled addon cannot produce that by construction.

What polling costs is answered by the addon, not by the poll rate: an implementation is free to keep a cache fed by platform events and answer from it, which is what FR-065’s “no measurable idle CPU” actually turns on.

Variants§

§

Values(Vec<(&'static str, bool)>)

It looked, and these are the values.

Ids must be ones Addon::signals declares. Anything else is dropped by the daemon rather than becoming a signal nobody can find the definition of.

§

Unavailable(String)

It could not look, and this is why.

FR-064: every signal it publishes then reads false, and the reason is this sentence rather than “the condition was false”. The two states are indistinguishable to a user and have different fixes — one is a configuration mistake, the other is a closed application.

Implementations§

Source§

impl Reading

Source

pub fn none() -> Self

A reading of nothing, from an addon that publishes no signals.

Source

pub fn get(&self, signal: &str) -> Option<bool>

The value of one signal, if this reading carries it.

Trait Implementations§

Source§

impl Clone for Reading

Source§

fn clone(&self) -> Reading

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 Reading

Source§

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

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

impl PartialEq for Reading

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Reading

Source§

impl StructuralPartialEq for Reading

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