Struct VirtualSign

pub struct VirtualSign<'a> { /* private fields */ }

Mock implementation of a single sign on a VirtualSignBus.

Encapsulates all the state associated with a virtual sign and implements the sign protocol for it. In general, you do not need to interact with this class directly; you simply pass it off to a VirtualSignBus, which forwards messages appropriately.

Examples

See VirtualSignBus.

Implementations

impl VirtualSign<'_>

pub fn new(address: Address, flip_style: PageFlipStyle) -> Self

Creates a new VirtualSign with the specified address and page flip style.

Examples

let sign = VirtualSign::new(Address(22), PageFlipStyle::Manual);
let bus = VirtualSignBus::new(iter::once(sign));

pub fn address(&self) -> Address

Returns the sign’s address.

Examples

let sign = VirtualSign::new(Address(22), PageFlipStyle::Manual);
assert_eq!(Address(22), sign.address());

pub fn state(&self) -> State

Returns the sign’s current state.

Examples

let sign = VirtualSign::new(Address(3), PageFlipStyle::Manual);
assert_eq!(State::Unconfigured, sign.state());

pub fn sign_type(&self) -> Option<SignType>

Returns the sign’s configured type.

This is initially None and will only be set if the sign has received a configuration message over the bus. Note that even if it has, this may still be None if the configuration did not match any known types (e.g. potentially when driving from a real ODK).

Examples

let sign = VirtualSign::new(Address(17), PageFlipStyle::Manual);
assert_eq!(None, sign.sign_type());

pub fn pages(&self) -> &[Page<'_>]

Returns the sign’s current Pages as a slice.

May be empty if no pages have yet been sent to this sign or it has been reset.

Examples

let sign = VirtualSign::new(Address(1), PageFlipStyle::Manual);
assert!(sign.pages().is_empty());

pub fn process_message<'a>( &mut self, message: &Message<'_>, ) -> Option<Message<'a>>

Handle a bus message, updating our state accordingly.

Examples

let mut sign = VirtualSign::new(Address(3), PageFlipStyle::Manual);
let response = sign.process_message(&Message::QueryState(Address(3)));
assert_eq!(Some(Message::ReportState(Address(3), State::Unconfigured)), response);

Trait Implementations

impl<'a> Clone for VirtualSign<'a>

fn clone(&self) -> VirtualSign<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for VirtualSign<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for VirtualSign<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for VirtualSign<'a>

fn eq(&self, other: &VirtualSign<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for VirtualSign<'a>

impl<'a> StructuralPartialEq for VirtualSign<'a>