Skip to main content

PapPacket

Struct PapPacket 

Source
pub struct PapPacket {
    pub connection_id: u8,
    pub function: PapFunction,
    pub sequence_num: u16,
    pub data: Vec<u8>,
}
Expand description

PAP packet structure

PAP packets are sent over ATP and have the following format:

  • Byte 0: Connection ID
  • Byte 1: Function code
  • Bytes 2-3: Sequence number (for some functions)
  • Remaining bytes: Function-specific data

Fields§

§connection_id: u8§function: PapFunction§sequence_num: u16§data: Vec<u8>

Implementations§

Source§

impl PapPacket

Source

pub const MIN_HEADER_LEN: usize = 2

Minimum header length (connection_id + function)

Source

pub fn parse(buf: &[u8]) -> Result<Self, PapError>

Parse a PAP packet from bytes

Source

pub fn to_bytes(&self, buf: &mut [u8]) -> Result<usize, PapError>

Encode a PAP packet to bytes

Source

pub fn len(&self) -> usize

Get the total length of this packet when encoded

Source

pub fn is_empty(&self) -> bool

Check if the packet is empty (no data)

Source

pub fn to_atp_parts(&self) -> ([u8; 4], &[u8])

Convert to ATP user bytes and data payload

PAP transmits its header in the ATP user bytes.

  • Byte 0: Connection ID
  • Byte 1: Function code
  • Bytes 2-3: Sequence number (or unused/zero)
Source

pub fn parse_from_atp( user_bytes: [u8; 4], data: &[u8], ) -> Result<Self, PapError>

Parse from ATP user bytes and data payload

Trait Implementations§

Source§

impl Clone for PapPacket

Source§

fn clone(&self) -> PapPacket

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PapPacket

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PapPacket

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for PapPacket

Source§

impl StructuralPartialEq for PapPacket

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> 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.