Struct HeaderSet

pub struct HeaderSet { /* private fields */ }

Maintains a collection of OBEX Headers that are sent & received in an OBEX packet. See OBEX 1.5 Section 3.4 for the ordering requirements and definitions of the supported Header types.

Implementations

impl HeaderSet

pub fn new() -> Self

pub fn from_headers(headers: Vec<Header>) -> Result<Self, Error>

pub fn from_header(header: Header) -> Self

pub fn is_empty(&self) -> bool

pub fn contains_header(&self, id: &HeaderIdentifier) -> bool

pub fn get(&self, id: &HeaderIdentifier) -> Option<&Header>

pub fn add(&mut self, header: Header) -> Result<(), Error>

Attempts to add the header to the HeaderSet. Returns Ok if the header was successfully added, Error if the header is incompatible with the existing headers in the set or if a different value already exists for the requested header.

pub fn try_append(&mut self, other: HeaderSet) -> Result<(), Error>

Attempts to combine HeaderSets together by modifying the current collection. Returns Ok on success, Error otherwise.

pub fn remove_body(&mut self, final_: bool) -> Result<Vec<u8>, Error>

Removes and returns the payload for the Body Header from the set. If final_ is set, then the EndOfBody header payload is returned. Returns Error if the expected Header is not present in the collection.

pub fn remove(&mut self, id: &HeaderIdentifier) -> Option<Header>

Removes and returns the specified Header from the collection. Returns None if the Header is not present.

pub fn try_add_srm( &mut self, local: SingleResponseMode, ) -> Result<SingleResponseMode, Error>

Attempts to add the SingleResponseMode Header to the current HeaderSet. local is the supported mode of the local transport. Returns the SingleResponseMode value that was added to the set on success, Error if it couldn’t be added or there was an incompatibility between the current set and local preferences.

pub fn try_add_connection_id( &mut self, id: &Option<ConnectionIdentifier>, ) -> Result<(), Error>

Trait Implementations

impl Clone for HeaderSet

fn clone(&self) -> HeaderSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderSet

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

Formats the value using the given formatter.

impl Decodable for HeaderSet

type Error = PacketError

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

Decodes into a new object, or returns an error.

impl Default for HeaderSet

fn default() -> HeaderSet

Returns the “default value” for a type.

impl Encodable for HeaderSet

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 PartialEq for HeaderSet

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