Skip to main content

MessageType

Enum MessageType 

Source
#[non_exhaustive]
#[repr(u8)]
pub enum MessageType {
Show 14 variants Announce = 1, Heartbeat = 2, Data = 3, Query = 4, Ack = 5, Leave = 6, Document = 7, OtaOffer = 16, OtaAccept = 17, OtaData = 18, OtaAck = 19, OtaComplete = 20, OtaResult = 21, OtaAbort = 22,
}
Expand description

Message types for the gossip protocol.

Marked #[non_exhaustive] so future protocol amendments can add variants without breaking exhaustive-match consumers in downstream crates (peat-mesh, peat-btle, peat-atak-plugin). Match arms must include a _ => fall-through to compile against the latest peat-lite.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Announce = 1

Announce presence and capabilities.

§

Heartbeat = 2

Heartbeat / keep-alive.

§

Data = 3

Data update (CRDT state).

§

Query = 4

Query for specific state.

§

Ack = 5

Acknowledge receipt.

§

Leave = 6

Leave notification.

§

Document = 7

Universal Document carrier (peat_mesh::Document, transport-agnostic).

Distinct from MessageType::Data’s typed-CRDT-primitive payload — Document carries an opaque envelope: collection name + doc id + timestamp + length-prefixed body bytes whose interpretation is owned by peat-mesh (or any consumer). Adding a new collection on the network requires zero codec changes downstream of peat-lite. See protocol::document for the wire layout.

§

OtaOffer = 16

OTA firmware offer (Full -> Lite).

§

OtaAccept = 17

OTA accept (Lite -> Full).

§

OtaData = 18

OTA data chunk (Full -> Lite).

§

OtaAck = 19

OTA chunk acknowledgement (Lite -> Full).

§

OtaComplete = 20

OTA transfer complete (Full -> Lite).

§

OtaResult = 21

OTA result (Lite -> Full).

§

OtaAbort = 22

OTA abort (either direction).

Implementations§

Source§

impl MessageType

Source

pub fn from_u8(v: u8) -> Option<Self>

Convert a raw byte to a MessageType, if valid.

Trait Implementations§

Source§

impl Clone for MessageType

Source§

fn clone(&self) -> MessageType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MessageType

Source§

impl Debug for MessageType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MessageType

Source§

impl PartialEq for MessageType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MessageType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.