Struct irp::Message

pub struct Message {
    pub carrier: Option<i64>,
    pub duty_cycle: Option<u8>,
    pub raw: Vec<u32>,
}

An encoded raw infrared message

Fields

carrier: Option<i64>

The carrier for the message. None means unknown, Some(0) means unmodulated

duty_cycle: Option<u8>

The duty cycle if known. Between 1% and 99%

raw: Vec<u32>

The actual flash and gap information in microseconds. All even entries are flash, odd are gap

Implementations

impl Message

pub fn new() -> Self

Create an empty packet

pub fn from_raw_slice(raw: &[u32]) -> Self

Create from raw vector of u32

pub fn extend(&mut self, other: &Message)

Concatenate two messages. Self must have a trailing gap.

pub fn has_trailing_gap(&self) -> bool

Do we have a trailing gap

pub fn remove_trailing_gap(&mut self)

Remove any trailing gap

pub fn print_rawir(&self) -> String

Print the flash and gap information as an raw ir string

pub fn parse(s: &str) -> Result<Self, String>

Parse a raw IR string of the form +9000 -45000 +2250

pub fn parse_mode2(s: &str) -> Result<Message, (usize, String)>

Parse pulse/space text. This format is produces by lirc’s mode2 tool. Some lirc drivers sometimes produce consecutive pulses or spaces, rather than alternating. These are automatically folded into one.

The return value is the line number and the error string.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the “default value” for a type.

impl PartialEq for Message

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

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

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

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

impl Eq for Message

impl StructuralPartialEq for Message