Crate meshtastic

A Rust library for communicating with and configuring Meshtastic devices.

Modules

api

This module contains the main API for interacting with Meshtastic devices. This module exposes the StreamApi and ConnectedStreamApi structs, as well as helper states within the state module.

errors

This module contains the global Error type of the library. This enum implements std::error::Error, std::fmt::Display, and std::fmt::Debug. This enum is used to represent all errors that can occur within the library.

packet

This module contains the structs, enums, and traits that are necessary to define the behavior of packets within the library. This module exposes the PacketDestination enum, the PacketRouter trait, and the PacketReceiver type.

protobufs

This module contains structs and enums that are generated from the protocol buffer (protobuf) definitions of the meshtastic/protobufs Git submodule. These structs and enums are not edited directly, but are instead generated at build time.

types

This module exposes wrappers around common types that are used throughout the library. These wrappers are used to simplify the API of the library, and to provide additional type safety.

utils

This module exposes utility functions that aren’t fundamental to the operation of the library, but simplify the configuration and usage of member methods.

Traits

Message

A re-export of the prost::Message trait, which is required to call the encode and decode methods on protocol buffer messages. A Protocol Buffers message.

Derive Macros

Message

A re-export of the prost::Message trait, which is required to call the encode and decode methods on protocol buffer messages.