Skip to main content

PacketBuilder

Struct PacketBuilder 

Source
pub struct PacketBuilder {
    pub addr: Address,
    pub ctrl: ControlByte,
    pub scb: Option<Scb>,
    pub code: u8,
    pub data: Vec<u8>,
}
Expand description

Builder for a single OSDP packet.

Caller fills in the high-level fields and calls PacketBuilder::encode (for non-secure packets) or PacketBuilder::encode_with_mac (for SCS_15..=SCS_18) to produce the bytes ready for transmission.

Fields§

§addr: Address

Address byte (with reply flag if PD → ACU).

§ctrl: ControlByte

CTRL byte (SQN + flags).

§scb: Option<Scb>

Security Control Block (None if CTRL.HAS_SCB is clear).

§code: u8

Command or reply code byte.

§data: Vec<u8>

DATA payload (already encrypted, if SCS_17/18).

Implementations§

Source§

impl PacketBuilder

Source

pub fn plain(addr: Address, ctrl: ControlByte, code: u8, data: Vec<u8>) -> Self

Build a packet with neither SCB nor MAC.

Source

pub fn encode(&self) -> Result<Vec<u8>, Error>

Encode the packet without any MAC.

If the CTRL byte has crate::packet::CtrlFlags::HAS_SCB set but the SCB type would require a MAC, the caller must use Self::encode_with_mac instead.

Source

pub fn encode_with_mac<F>(&self, mac_fn: F) -> Result<Vec<u8>, Error>
where F: FnOnce(&[u8]) -> [u8; 4],

Encode the packet, computing the MAC trailer with mac_fn.

mac_fn receives the bytes from SOM through end-of-DATA (i.e. what the wire MAC is computed over) and returns the first 4 bytes of the resulting MAC.

Trait Implementations§

Source§

impl Clone for PacketBuilder

Source§

fn clone(&self) -> PacketBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PacketBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.