Crate ockam_core
source ·Expand description
Core types of the Ockam library.
This crate contains the core types of the Ockam library and is intended for use by other crates that provide features and add-ons to the main Ockam library.
The main Ockam crate re-exports types defined in this crate.
Re-exports
pub use access_control::*;
Modules
- Access control
- A facade around the various collections and primitives needed to support
std
,no_std + alloc
orno_std
targets. - Debugger
- Environmental variables
- A module to export the error code in a meaningful way
- Flow Control
- Encoding
- Core types and traits of the Ockam vault.
Macros
Structs
- A generic address type.
- An error which is returned when address parsing from string fails.
- A passthrough marker message type.
- The state of a completed key exchange.
- A new type around
Cow<'_, [u8]>
that borrows from input. - A new type around
Cow<'_, str>
that borrows from input. - The type of errors returned by Ockam functions.
- Contains metadata that will only be routed locally within the local Ockam Node.
- A message type that is routed locally within a single node.
- A
Mailbox
controls the dispatch of incoming messages for a particularAddress
Note that [Worker
], [Processor
] andContext
may have multiple Mailboxes (with different addresses), but they always have exactly one mpsc receiver (message queue) - A message type that is not subject to any encoding or decoding.
- A user-defined protocol identifier.
- A message addressed to the relay responsible for delivery of the wrapped
LocalMessage
- A full route to a peer.
- A utility type for building and manipulating routes.
- A message wrapper that provides message route information.
- A generic transport message type.
- The transport type of an [
Address
]. - A type tag represents a type as a unique numeric value.
- Unsigned integer implementation that supports serde_bare serialization as a 64 bit
uint
type.
Enums
- Enum to store the cause of an address parsing failure.
- A routing specific error type.
Constants
- The local transport type.
Traits
- Clone trait for async structs.
- Decode a slice.
- Encode the type into an
Encoded
type. - A trait implemented by both Initiator and Responder peers.
- A user defined message that can be serialised and deserialized.
- A creator of both initiator and responder peers of a key exchange.
- Defines an interface for Ockam Workers that need to continuously perform background operations.
- Defines the core interface shared by all Ockam Workers.
Functions
- Produces Ok(true) to avoid an ambiguous reading from using the unadorned value in auth code.
- Produces Ok(false) to avoid an ambiguous reading from using the unadorned value in auth code.
Type Definitions
- Alias of the type used for encoded data.
Attribute Macros
- Mark an Ockam Processor implementation.
- Mark an Ockam Worker implementation.
Derive Macros
- Implements the
AsyncTryClone
trait for a type. - Implements the
Message
trait for a type.