Struct SignalView 

pub struct SignalView {
    pub name: String,
    pub description: String,
    pub causal: bool,
    pub because: String,
    pub engine: String,
    pub at: String,
    pub value: Option<f64>,
}

One signal a plugin publishes, as it stands right now (#163).

A signal that is declared and has no value is shown with none, not with a zero and not with whatever it last said. That is the invariant made visible: a reader looking at this list should be able to see the difference between “nothing to say” and “saying nothing has changed”.

Fields

name: String

description: String

causal: bool

Whether each value is computed from what was known at that instant. A study may gate on a causal signal and never on a descriptive one.

because: String

Why it is not causal, in the provider’s own words. Empty when it is.

engine: String

What computes it, by name and version.

at: String

The instant the value describes, empty when there is no value.

value: Option<f64>

None is the answer for a signal that is declared and silent, and for one whose provider has gone away.

Implementations

impl SignalView

pub fn value(&self) -> f64

Returns the value of value, or the default value if value is unset.

Trait Implementations

impl Clone for SignalView

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalView

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

Formats the value using the given formatter.

impl Default for SignalView

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SignalView

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SignalView

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SignalView

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SignalView

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SignalView