Expand description

End-to-end encryption and mutual authentication for distributed applications.

Re-exports

pub use ockam_abac as abac;
pub use ockam_identity as identity;

Modules

Access Control

Authenticated Storage

Ockam general bi-directional channel

Compatibility adapter, mostly for no_std use.

Building block for Attribute-based access control

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.

Module containing types for managing Streams.

Types and traits relating to ockam vaults.

A collection of utility workers for various use cases.

Macros

Creates a new Route from a comma-delimited list of Addresses.

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 message type that is routed locally within a single node.

A Mailbox controls the dispatch of incoming messages for a particular Address

A collection of Mailboxes for a [Context]

Start a node with a custom setup configuration

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.

Start a Worker with a custom AccessControl configuration

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.

Defines an interface for Ockam Workers that need to continuously perform background operations.

Handle a single type of message for a worker system-address

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.

A generator for unique, human-readable identifiers suitable for use in distributed systems.

Type Definitions

Alias of the type used for encoded data.

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.

Implements the Message trait for a type.