pub struct CannedMessageDocument { /* private fields */ }Expand description
Wrapper around CannedMessageAckEvent that implements DocumentType.
This enables CannedMessage events to sync through the hive-btle mesh using the extensible document registry.
Implementations§
Source§impl CannedMessageDocument
impl CannedMessageDocument
Sourcepub fn new(event: CannedMessageAckEvent) -> Self
pub fn new(event: CannedMessageAckEvent) -> Self
Create a new document from a CannedMessageAckEvent.
Sourcepub fn inner(&self) -> &CannedMessageAckEvent
pub fn inner(&self) -> &CannedMessageAckEvent
Get a reference to the inner event.
Sourcepub fn inner_mut(&mut self) -> &mut CannedMessageAckEvent
pub fn inner_mut(&mut self) -> &mut CannedMessageAckEvent
Get a mutable reference to the inner event.
Sourcepub fn into_inner(self) -> CannedMessageAckEvent
pub fn into_inner(self) -> CannedMessageAckEvent
Consume and return the inner event.
Sourcepub fn ack(&mut self, node_id: u32, ack_timestamp: u64) -> bool
pub fn ack(&mut self, node_id: u32, ack_timestamp: u64) -> bool
Record an ACK from a node.
Delegates to CannedMessageAckEvent::ack.
Sourcepub fn source_node(&self) -> u32
pub fn source_node(&self) -> u32
Get the source node ID.
Sourcepub fn message_code(&self) -> u8
pub fn message_code(&self) -> u8
Get the message code.
Trait Implementations§
Source§impl Clone for CannedMessageDocument
impl Clone for CannedMessageDocument
Source§fn clone(&self) -> CannedMessageDocument
fn clone(&self) -> CannedMessageDocument
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for CannedMessageDocument
impl Debug for CannedMessageDocument
Source§impl DocumentType for CannedMessageDocument
impl DocumentType for CannedMessageDocument
Source§const TYPE_ID: u8 = CANNED_MESSAGE_TYPE_ID
const TYPE_ID: u8 = CANNED_MESSAGE_TYPE_ID
Unique type identifier (marker byte in 0xC0-0xCF range).
Source§fn encode(&self) -> Vec<u8> ⓘ
fn encode(&self) -> Vec<u8> ⓘ
Encode to wire format (payload only, not including type header).
Source§fn merge(&mut self, other: &Self) -> bool
fn merge(&mut self, other: &Self) -> bool
Merge with another instance using CRDT semantics. Read more
Source§fn to_delta_op(&self) -> Option<AppOperation>
fn to_delta_op(&self) -> Option<AppOperation>
Convert to a delta operation for efficient sync. Read more
Source§fn apply_delta_op(&mut self, op: &AppOperation) -> bool
fn apply_delta_op(&mut self, op: &AppOperation) -> bool
Apply a delta operation to this document. Read more
Source§impl From<CannedMessageAckEvent> for CannedMessageDocument
impl From<CannedMessageAckEvent> for CannedMessageDocument
Source§fn from(event: CannedMessageAckEvent) -> Self
fn from(event: CannedMessageAckEvent) -> Self
Converts to this type from the input type.
Source§impl From<CannedMessageDocument> for CannedMessageAckEvent
impl From<CannedMessageDocument> for CannedMessageAckEvent
Source§fn from(doc: CannedMessageDocument) -> Self
fn from(doc: CannedMessageDocument) -> Self
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for CannedMessageDocument
impl RefUnwindSafe for CannedMessageDocument
impl Send for CannedMessageDocument
impl Sync for CannedMessageDocument
impl Unpin for CannedMessageDocument
impl UnsafeUnpin for CannedMessageDocument
impl UnwindSafe for CannedMessageDocument
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more