Enum bt_obex::header::Header

pub enum Header {
    Count(u32),
    Name(Option<ObexString>),
    Type(MimeType),
    Length(u32),
    TimeIso8601(NaiveDateTime),
    Time4Byte(NaiveDateTime),
    Description(ObexString),
    Target(Vec<u8>),
    Http(Vec<u8>),
    Body(Vec<u8>),
    EndOfBody(Vec<u8>),
    Who(Vec<u8>),
    ConnectionId(ConnectionIdentifier),
    ApplicationParameters(Vec<u8>),
    AuthenticationChallenge(Vec<u8>),
    AuthenticationResponse(Vec<u8>),
    CreatorId(u32),
    WanUuid(Uuid),
    ObjectClass(Vec<u8>),
    SessionParameters(Vec<u8>),
    SessionSequenceNumber(u8),
    ActionId(ActionIdentifier),
    DestName(ObexString),
    Permissions(u32),
    SingleResponseMode(SingleResponseMode),
    SingleResponseModeParameters(u8),
    User(UserDefinedHeader),
}

The building block of an OBEX object. A single OBEX object consists of one or more Headers. Defined in OBEX 1.5 Section 2.0.

Variants

Count(u32)

Name(Option<ObexString>)

The Name header can be empty which is a special parameter for the GET and SETPATH operations. It is also valid to provide a Name header with an empty OBEX string. See OBEX 1.5 Section 2.2.2.

Type(MimeType)

Length(u32)

Number of bytes.

TimeIso8601(NaiveDateTime)

Time represented as a well-formed NaiveDateTime (no timezone). This is typically UTC. See OBEX 1.5 Section 2.2.5.

Time4Byte(NaiveDateTime)

Time represented as the number of seconds elapsed since midnight UTC on January 1, 1970. This is saved as a well-formed NaiveDateTime (no timezone).

Description(ObexString)

Target(Vec<u8>)

Http(Vec<u8>)

Body(Vec<u8>)

EndOfBody(Vec<u8>)

Who(Vec<u8>)

ConnectionId(ConnectionIdentifier)

ApplicationParameters(Vec<u8>)

AuthenticationChallenge(Vec<u8>)

AuthenticationResponse(Vec<u8>)

CreatorId(u32)

WanUuid(Uuid)

ObjectClass(Vec<u8>)

SessionParameters(Vec<u8>)

SessionSequenceNumber(u8)

ActionId(ActionIdentifier)

DestName(ObexString)

Permissions(u32)

4-byte bit mask.

SingleResponseMode(SingleResponseMode)

SingleResponseModeParameters(u8)

1-byte quantity containing the parameters for the SRM session.

User(UserDefinedHeader)

User defined Header type.

Implementations

impl Header

pub fn identifier(&self) -> HeaderIdentifier

pub fn name(s: &str) -> Self

pub fn empty_name() -> Self

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Decodable for Header

type Error = PacketError

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

Decodes into a new object, or returns an error.

impl Encodable for Header

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 From<SingleResponseMode> for Header

fn from(src: SingleResponseMode) -> Header

Converts to this type from the input type.

impl PartialEq for Header

fn eq(&self, other: &Header) -> 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 Header