Struct Message

pub struct Message<'a>(/* private fields */);

OpenThread Message. Functional equivalent of otsys::otMessage.

This type cannot be instantiated directly: owned instances are passed around in an ot::Box<ot::Message>, or OtMessageBox for short.

otMessage instances keep a reference to their otInstance, so this type does not implement Send nor Sync.

Implementations

impl<'a> Message<'a>

pub fn ip6_new<T: Boxable<OtType = otInstance>>( instance: &'a T, settings: Option<&Settings>, ) -> Result<Box<Message<'a>>, NoBufs>

Functional equivalent of otsys::otIp6NewMessage.

pub fn ip6_new_from_bytes<T: Boxable<OtType = otInstance>, D: AsRef<[u8]>>( instance: &'a T, data: D, settings: Option<&Settings>, ) -> Result<Box<Message<'a>>, MalformedOrNoBufs>

Functional equivalent of otsys::otIp6NewMessageFromBuffer.

Note that, due to limitation in how the underlying method can report errors, it is impossible to differentiate the “NoBufs” error condition from the “IPv6 header malformed” error condition, hence the unusual error type.

pub fn ip4_new<T: Boxable<OtType = otInstance>>( instance: &'a T, settings: Option<&Settings>, ) -> Result<Box<Message<'a>>, NoBufs>

Functional equivalent of otsys::otIp4NewMessage.

impl<'a> Message<'a>

pub fn udp_new<T: Boxable<OtType = otInstance>>( instance: &'a T, settings: Option<&Settings>, ) -> Result<Box<Message<'a>>, NoBufs>

Functional equivalent of otsys::otIp6NewMessage.

impl Message<'_>

pub fn append(&mut self, data: &[u8]) -> Result

Functional equivalent of otsys::otMessageAppend.

The length of data must be less than 2^16, or else the method will return an Err with ot::Error::InvalidArgs.

pub fn is_link_security_enabled(&self) -> bool

Functional equivalent of otsys::otMessageIsLinkSecurityEnabled.

pub fn len(&self) -> usize

Functional equivalent of otsys::otMessageGetLength.

pub fn set_len(&mut self, len: usize) -> Result

Functional equivalent of otsys::otMessageSetLength.

In addition to the error codes outlined in otsys::otMessageSetLength, this method will return Err(Error::InvalidArgs) if the len parameter is larger than 65,535 bytes.

pub fn offset(&self) -> usize

Functional equivalent of otsys::otMessageGetOffset.

pub fn set_offset(&mut self, offset: usize)

Functional equivalent of otsys::otMessageSetOffset.

Calling this method with an offset larger than or equal to exceed 2^16 will cause a panic.

pub fn set_direct_transmission(&mut self, direct_transmission: bool)

This function sets/forces the message to be forwarded using direct transmission. Functional equivalent of otsys::otMessageSetDirectTransmission.

Default setting for a new message is false.

pub fn rssi(&self) -> Decibels

Functional equivalent of otsys::otMessageGetRss.

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

Renders this message to a new Vec<u8> using otsys::otMessageRead.

Trait Implementations

impl Boxable for Message<'_>

type OtType = otMessage

The underlying implementation-opaque OpenThread type used by the standard C-API.

unsafe fn finalize(&mut self)

Finalizes or frees the underlying OpenThread object.

unsafe fn ref_from_ot_ptr<'a>(ptr: *mut Self::OtType) -> Option<&'a Self>

Creates a reference to a safe wrapper object from an OpenThread pointer.

unsafe fn ref_from_ot_const_ptr<'a>( ptr: *const Self::OtType, ) -> Option<&'a Self>

Creates a reference to a safe wrapper object from an OpenThread const pointer.

unsafe fn mut_from_ot_ptr<'a>(ptr: *mut Self::OtType) -> Option<&'a mut Self>

Creates a mutable reference to a safe wrapper object from an OpenThread pointer.

fn as_ot_ptr(&self) -> *mut Self::OtType

Returns the underlying OpenThread pointer for this object. The default implementation simply casts the reference to a pointer.

impl Debug for Message<'_>

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

Formats the value using the given formatter.