Struct pelcodrs::MessageBuilder

pub struct MessageBuilder { /* fields omitted */ }

Builder of Message (standard) instances.

Provided methods fill the message with corresponding bits, then MessageBuilder::finalize() produces the final Message.

Please note that currently no logical validation is done. For example the "sense" bit can be overwritten, and thus invalidate previous method call.

Example

let msg = MessageBuilder::new(10)
    .camera_on()
    .focus_far()
    .direction(Direction::DOWN)
    .tilt(Speed::Range(0.5))
    .finalize()?;

assert_eq!(&[0xFF, 0x0A, 0x88, 0x90, 0x00, 0x20, 0x42], msg.as_ref());

Methods

impl MessageBuilder

pub fn new(address: u8) -> MessageBuilder

pub fn direction(&mut self, direction: Direction) -> &mut Self

pub fn down(&mut self) -> &mut Self

pub fn up(&mut self) -> &mut Self

pub fn left(&mut self) -> &mut Self

pub fn right(&mut self) -> &mut Self

pub fn pan(&mut self, speed: Speed) -> &mut Self

pub fn tilt(&mut self, speed: Speed) -> &mut Self

pub fn stop(&mut self) -> &mut Self

pub fn zoom_in(&mut self) -> &mut Self

pub fn zoom_out(&mut self) -> &mut Self

pub fn camera_on(&mut self) -> &mut Self

pub fn camera_off(&mut self) -> &mut Self

pub fn auto_scan(&mut self) -> &mut Self

pub fn manual_scan(&mut self) -> &mut Self

pub fn close_iris(&mut self) -> &mut Self

pub fn open_iris(&mut self) -> &mut Self

pub fn focus_far(&mut self) -> &mut Self

pub fn focus_near(&mut self) -> &mut Self

pub fn finalize(self) -> Result<Message>

Trait Implementations

impl From<MessageBuilder> for Message

fn from(draft: MessageBuilder) -> Self

Performs the conversion.

impl Clone for MessageBuilder

fn clone(&self) -> MessageBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MessageBuilder

impl PartialEq<MessageBuilder> for MessageBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for MessageBuilder

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

Formats the value using the given formatter.