Enum FramerConfig 

pub enum FramerConfig {
    Delimiter {
        delimiter: ByteSeq,
        include_delimiter: bool,
        max_buffer_size: Option<usize>,
    },
    Readline {
        delimiter: Option<ByteSeq>,
        include_delimiter: bool,
        max_buffer_size: Option<usize>,
        encoding: Option<String>,
    },
    ByteLength {
        length: usize,
    },
    InterByteTimeout {
        interval_ms: u64,
        max_buffer_size: Option<usize>,
    },
    PacketLength {
        delimiter: Option<OneOrMany>,
        delimiter_bytes: Option<usize>,
        packet_overhead: Option<usize>,
        length_bytes: Option<usize>,
        length_offset: Option<usize>,
        max_len: Option<usize>,
        max_buffer_size: Option<usize>,
    },
    Ready {
        delimiter: ByteSeq,
    },
    Regex {
        regex: String,
        max_buffer_size: Option<usize>,
        encoding: Option<String>,
    },
    StartEnd {
        start_delimiter: ByteSeq,
        end_delimiter: ByteSeq,
        include_start_delimiter: bool,
        include_end_delimiter: bool,
        max_buffer_size: Option<usize>,
    },
    Slip(SlipOptions),
    CcTalk {
        max_delay_ms: Option<u64>,
    },
}

Parser selection, as sent from JavaScript ({ type: "readline", … }).

Variants

Delimiter

Split on a byte sequence (@serialport/parser-delimiter).

Fields

delimiter: ByteSeq

include_delimiter: bool

max_buffer_size: Option<usize>

Readline

Split on "\n" by default (@serialport/parser-readline).

Fields

delimiter: Option<ByteSeq>

include_delimiter: bool

max_buffer_size: Option<usize>

encoding: Option<String>

Node’s string-rendering option; accepted and ignored (frames are bytes).

ByteLength

Fixed-size frames (@serialport/parser-byte-length).

Fields

length: usize

InterByteTimeout

A frame ends after interval_ms of silence (@serialport/parser-inter-byte-timeout).

Fields

interval_ms: u64

max_buffer_size: Option<usize>

PacketLength

Delimiter + little-endian length field (@serialport/parser-packet-length).

Fields

delimiter: Option<OneOrMany>

One value or a list; read big-endian over delimiterBytes wire bytes.

delimiter_bytes: Option<usize>

packet_overhead: Option<usize>

length_bytes: Option<usize>

length_offset: Option<usize>

max_len: Option<usize>

max_buffer_size: Option<usize>

Ready

Drop everything until a marker, then pass data through (@serialport/parser-ready).

Fields

delimiter: ByteSeq

Regex

Split on a regular expression over UTF-8 text (@serialport/parser-regex).

Fields

regex: String

max_buffer_size: Option<usize>

encoding: Option<String>

Node’s string-rendering option; accepted and ignored (frames are bytes).

StartEnd

Frames between a start and an end marker (@serialport/parser-start-end).

Fields

start_delimiter: ByteSeq

end_delimiter: ByteSeq

include_start_delimiter: bool

include_end_delimiter: bool

max_buffer_size: Option<usize>

Slip(SlipOptions)

SLIP (RFC 1055) decoder (@serialport/parser-slip-encoder SlipDecoder).

CcTalk

ccTalk frames, length in byte 1 (@serialport/parser-cctalk).

Fields

max_delay_ms: Option<u64>

Drop a partial frame after this gap; 0 disables. Default 50.

Implementations

impl FramerConfig

pub fn build(&self) -> Result<Box<dyn Framer>, ConfigError>

Validate options and build the framer.

Trait Implementations

impl Clone for FramerConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FramerConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FramerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FramerConfig

impl PartialEq for FramerConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FramerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FramerConfig