Expand description
Ockam is a library for end-to-end encryption and mutual authentication for distributed applications.
For a comprehensive introduction to Ockam, see https://www.ockam.io/learn.
Re-exports
pub use ockam_identity as identity;
Modules
Ockam general bi-directional channel
Compatibility adapter, mostly for no_std
use.
A module to export the error code in a meaningful way
Module containing types required for key exchange.
Ockam pipe module
Pipe2 composition system
Advanced Ockam worker protocols
Registration with Ockam Hub, and forwarding to local workers.
Types and traits relating to ockam vaults.
A collection of utility workers for various use cases.
Macros
Structs
A generic address type.
A passthrough marker message type.
Context contains Node state and references to the runtime.
Allow to send message to destination address periodically after some delay Only one scheduled heartbeat allowed at a time Dropping this handle cancels scheduled heartbeat
The type of errors returned by Ockam functions.
Underlying Ockam node executor
Alias worker to register remote workers under local names.
A lease for managing secrets
A message type that is routed locally within a single node.
A message metadata wrapper type
A user-defined protocol identifier.
A full route to a peer.
A message wrapper that provides message route information.
An abstraction to build a worker system graph
High level management interface for TCP transports
A generic transport message type.
A composable worker system type.
Enums
An enumeration of different error types emitted by this library.
Constants
TCP address type constant
Traits
Clone trait for async structs.
A user defined message that can be serialised and deserialized.
Handle a single type of message for a worker system-address
Defines the core interface shared by all Ockam Workers.
Functions
Start a node
A generator for unique, human-readable identifiers suitable for use in distributed systems.
Type Definitions
Attribute Macros
Marks an async function to be run in an ockam node.
Mark an Ockam Processor implementation.
Marks an async test function to be run in an ockam node.
Mark an Ockam Worker implementation.
Derive Macros
Implements the AsyncTryClone
trait for a type.