Struct ReaderHandle 

pub struct ReaderHandle<E: Encoding = FlatBuffers> { /* private fields */ }

The &self port roles: Attached, Clock, SignalReader, FixedReader, and the two signal extensions.

It is Send + Sync, so several threads may hold one and read at once, and a face that needs only SignalReader can be built over this handle directly rather than over the aggregate: like every handle, it carries the runtime’s encoding E, which such a face reads from it.

Trait Implementations

impl<E: Encoding> Attached for ReaderHandle<E>

fn catalog(&self) -> &CatalogRef

The catalog this port serves.

impl<E: Encoding> Clock for ReaderHandle<E>

fn now(&self) -> Timestamp

The current time in the platform time base.

impl<E: Encoding> CoherentSignals for ReaderHandle<E>

fn read_coherent( &self, iface: InterfaceNo, ords: &[Ordinal], out: &mut [u8], samples: &mut [RawSample], ) -> Result<usize, ReadError>

Answers every ordinal in ords from one publication. Copies the values into out one after another, writes one RawSample for each ordinal into samples in the order of ords, and returns the number of bytes written to out.

impl<E: Encoding> Encoded for ReaderHandle<E>

type Encoding = E

The encoding of the bytes this port carries.

impl<E: Encoding> FixedReader for ReaderHandle<E>

fn read_fixed( &self, iface: InterfaceNo, ord: Ordinal, out: &mut [u8], ) -> Result<usize, ReadError>

Copies the provisioned value into the front of out and returns its length.

impl<E: Encoding> ScannableSignals for ReaderHandle<E>

fn generation(&self, iface: InterfaceNo) -> u64

The interface’s generation: a counter that each commit to the interface increments.

fn scan(&self, marks: &mut [Watermark], out: &mut [Changed]) -> usize

Writes the changes into out, interface by interface, in the order of marks, and updates marks. An interface’s changes are written all together or not at all: when they do not fit in the rest of out, none of them is written, that interface’s mark is not updated, and scan returns the number of entries written so far.

impl<E: Encoding> SignalReader for ReaderHandle<E>

fn read( &self, iface: InterfaceNo, ord: Ordinal, out: &mut [u8], ) -> Result<RawSample, ReadError>

Copies the signal’s current value into the front of out and returns its provenance, its freshness and its envelope. The runtime resolves both the provenance and the freshness.

impl<E: Encoding> Wakeable for ReaderHandle<E>

fn wake_on(&self, _: Interest, waker: &Waker)

Wakes waker when the thing what names may have changed, under the contract above.