Struct ParsedPacket 

pub struct ParsedPacket<'a> {
    pub addr: Address,
    pub ctrl: ControlByte,
    pub scb: Option<ScbView<'a>>,
    pub code: u8,
    pub data: &'a [u8],
    pub mac: Option<[u8; 4]>,
    pub trailer: Trailer,
}

View of a parsed OSDP packet, borrowed from the input slice.

The codec is zero-copy: payload, SCB data, and MAC slices all point into the input buffer.

Fields

addr: Address

Source/destination address (with reply flag if from PD).

ctrl: ControlByte

Decoded CTRL byte.

scb: Option<ScbView<'a>>

Security Control Block, if CTRL.HAS_SCB.

code: u8

Command or reply code byte.

data: &'a [u8]

Application data following the code byte (excluding any MAC trailer and the CRC/checksum).

mac: Option<[u8; 4]>

4-byte MAC, if SCS_15..18.

trailer: Trailer

Trailer kind.

Implementations

impl<'a> ParsedPacket<'a>

pub fn parse(buf: &'a [u8]) -> Result<(Self, usize), Error>

Parse a complete packet from buf.

Returns the parsed packet view and the number of bytes consumed (which equals the value of the LEN field).

The parser is total — every malformed input returns a typed Error rather than panicking.

Example

use osdp::packet::ParsedPacket;
// osdp_POLL frame addressed to PD 0x05, SQN=0, CRC-16/KERMIT trailer.
let bytes = [0x53, 0x05, 0x08, 0x00, 0x04, 0x60, 0xBC, 0x89];
let (parsed, used) = ParsedPacket::parse(&bytes)?;
assert_eq!(used, bytes.len());
assert_eq!(parsed.code, 0x60); // osdp_POLL
assert!(parsed.data.is_empty());

Trait Implementations

impl<'a> Clone for ParsedPacket<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParsedPacket<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ParsedPacket<'a>

fn eq(&self, other: &ParsedPacket<'a>) -> 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<'a> Copy for ParsedPacket<'a>

impl<'a> Eq for ParsedPacket<'a>

impl<'a> StructuralPartialEq for ParsedPacket<'a>