Struct Packet

pub struct Packet<T>
where
    T: Clone + Debug + PartialEq,
    for<'a> &'a T: Into<u8>,
{ /* private fields */ }

An OBEX Packet that can be encoded/decoded to/from a raw byte buffer. This is sent over the L2CAP or RFCOMM transport.

Implementations

impl<T> Packet<T>

where T: Clone + Debug + PartialEq, for<'a> &'a T: Into<u8>,

pub const MIN_PACKET_SIZE: usize = 3usize

The minimum packet consists of an opcode (1 byte) and packet length (2 bytes).

pub fn new(code: T, data: Vec<u8>, headers: HeaderSet) -> Self

pub fn code(&self) -> &T

pub fn data(&self) -> &Vec<u8>

pub fn headers(&self) -> &HeaderSet

impl Packet<OpCode>

pub fn new_connect(max_packet_size: u16, headers: HeaderSet) -> Self

Returns a CONNECT request packet with the provided headers.

pub fn new_disconnect(headers: HeaderSet) -> Self

pub fn new_get(headers: HeaderSet) -> Self

pub fn new_get_final(headers: HeaderSet) -> Self

pub fn new_put(headers: HeaderSet) -> Self

pub fn new_put_final(headers: HeaderSet) -> Self

pub fn new_set_path( flags: SetPathFlags, headers: HeaderSet, ) -> Result<Self, Error>

pub fn new_abort(headers: HeaderSet) -> Self

impl Packet<ResponseCode>

pub fn new_no_data(code: ResponseCode, headers: HeaderSet) -> Self

pub fn new_connect( code: ResponseCode, max_packet_size: u16, headers: HeaderSet, ) -> Self

pub fn new_disconnect(headers: HeaderSet) -> Self

pub fn new_setpath(code: ResponseCode, headers: HeaderSet) -> Self

pub fn new_get(code: ResponseCode, headers: HeaderSet) -> Self

pub fn expect_code( self, request: OpCode, expected: ResponseCode, ) -> Result<Self, Error>

pub fn decode(buf: &[u8], request: OpCode) -> Result<Self, PacketError>

Attempts to decode the raw buf into a ResponsePacket for the provided request type.

Trait Implementations

impl<T> Clone for Packet<T>

where T: Clone + Debug + PartialEq + Clone, for<'a> &'a T: Into<u8>,

fn clone(&self) -> Packet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Packet<T>

where T: Clone + Debug + PartialEq + Debug, for<'a> &'a T: Into<u8>,

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

Formats the value using the given formatter.

impl<T> Encodable for Packet<T>

where T: Clone + Debug + PartialEq, for<'a> &'a T: Into<u8>,

type Error = PacketError

fn encoded_len(&self) -> usize

Returns the number of bytes necessary to encode |self|.

fn encode(&self, buf: &mut [u8]) -> Result<(), Self::Error>

Writes the encoded version of |self| at the start of |buf|. |buf| must be at least |self.encoded_len()| length.

impl<T> From<Packet<T>> for HeaderSet

where T: Clone + Debug + PartialEq, for<'a> &'a T: Into<u8>,

fn from(value: Packet<T>) -> Self

Converts to this type from the input type.

impl<T> PartialEq for Packet<T>

where T: Clone + Debug + PartialEq + PartialEq, for<'a> &'a T: Into<u8>,

fn eq(&self, other: &Packet<T>) -> 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<T> StructuralPartialEq for Packet<T>

where T: Clone + Debug + PartialEq, for<'a> &'a T: Into<u8>,