Struct bt_rfcomm::frame::Frame

pub struct Frame {
    pub role: Role,
    pub dlci: DLCI,
    pub data: FrameData,
    pub poll_final: bool,
    pub command_response: CommandResponse,
    pub credits: Option<u8>,
}

The highest-level unit of data that is passed around in RFCOMM.

Fields

role: Role

The role of the device associated with this frame.

dlci: DLCI

The DLCI associated with this frame.

data: FrameData

The data associated with this frame.

poll_final: bool

The P/F bit for this frame. See RFCOMM 5.2.1 which describes the usages of the P/F bit in RFCOMM.

command_response: CommandResponse

Whether this frame is a Command or Response frame.

credits: Option<u8>

The credits associated with this frame. Credits are only applicable to UIH frames when credit-based flow control is enabled. See RFCOMM 6.5.

Implementations

impl Frame

pub fn parse( role: Role, credit_based_flow: bool, buf: &[u8] ) -> Result<Self, FrameParseError>

Attempts to parse the provided buf into a Frame.

role is the current Role of the RFCOMM Session. credit_based_flow indicates whether credit-based flow control is turned on for this Session.

pub fn make_sabm_command(role: Role, dlci: DLCI) -> Self

pub fn make_dm_response(role: Role, dlci: DLCI) -> Self

pub fn make_ua_response(role: Role, dlci: DLCI) -> Self

pub fn make_mux_command(role: Role, data: MuxCommand) -> Self

pub fn make_user_data_frame( role: Role, dlci: DLCI, user_data: UserData, credits: Option<u8> ) -> Self

pub fn make_disc_command(role: Role, dlci: DLCI) -> Self

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Encodable for Frame

type Error = FrameParseError

fn encoded_len(&self) -> usize

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

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

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

impl PartialEq for Frame

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Frame