Enum XvcCommand 

pub enum XvcCommand {
    GetInfo,
    SetTck,
    Shift,
}

Possible commands that are known to the XVC protocol.

Variants

GetInfo

SetTck

Shift

Implementations

impl XvcCommand

pub fn parse(buf: &mut &[u8]) -> Result<XvcCommand, ParseErr>

Parse a command from a buffer.

Example

use xvc_protocol::{XvcCommand};

let mut buf: &[u8] = b"getinfo:";
let command = XvcCommand::parse(&mut buf).expect("Parsing a large enough buffer should not fail");
assert_eq!(command, XvcCommand::GetInfo);
assert_eq!(buf.len(), 0);

If the buffer is not large enough, ParseErr::Incomplete is returned. This usually indicates to the caller to read more bytes into the buffer:

A buffer that is too large is permitted. After a successful parse the buffer is advanced past the consumed command bytes:

use xvc_protocol::XvcCommand;

let mut buf: &[u8] = b"settck:\x64";
let command = XvcCommand::parse(&mut buf).expect("Parsing a large enough buffer should not fail");
assert_eq!(command, XvcCommand::SetTck);
assert_eq!(buf.len(), 1);

Trait Implementations

impl Clone for XvcCommand

fn clone(&self) -> XvcCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XvcCommand

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

Formats the value using the given formatter.

impl PartialEq for XvcCommand

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

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

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 Eq for XvcCommand

impl StructuralPartialEq for XvcCommand