Crate ockam

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

channel

Ockam general bi-directional channel

compat

Compatibility adapter, mostly for no_std use.

errcode

A module to export the error code in a meaningful way

key_exchange

Module containing types required for key exchange.

pipe

Ockam pipe module

pipe2

Pipe2 composition system

protocols

Advanced Ockam worker protocols

remote

Registration with Ockam Hub, and forwarding to local workers.

stream

Module containing types for managing Streams.

vault

Types and traits relating to ockam vaults.

workers

A collection of utility workers for various use cases.

Macros

route

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

Structs

Address

A generic address type.

Any

A passthrough marker message type.

Context

Context contains Node state and references to the runtime.

DelayedEvent

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

Error

The type of errors returned by Ockam functions.

Executor

Underlying Ockam node executor

ForwardingService

Alias worker to register remote workers under local names.

Lease

A lease for managing secrets

LocalMessage

A message type that is routed locally within a single node.

OckamMessage

A message metadata wrapper type

ProtocolId

A user-defined protocol identifier.

Route

A full route to a peer.

Routed

A message wrapper that provides message route information.

SystemBuilder

An abstraction to build a worker system graph

TcpTransport

High level management interface for TCP transports

TransportMessage

A generic transport message type.

WorkerSystem

A composable worker system type.

Enums

OckamError

An enumeration of different error types emitted by this library.

Constants

TCP

TCP address type constant

Traits

AsyncTryClone

Clone trait for async structs.

Message

A user defined message that can be serialised and deserialized.

SystemHandler

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

Worker

Defines the core interface shared by all Ockam Workers.

Functions

start_node

Start a node

unique_with_prefix

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

Type Definitions

Encoded

Alias of the type used for encoded data.

Result

Attribute Macros

node

Marks an async function to be run in an ockam node.

processor

Mark an Ockam Processor implementation.

test

Marks an async test function to be run in an ockam node.

worker

Mark an Ockam Worker implementation.

Derive Macros

AsyncTryClone

Implements the AsyncTryClone trait for a type.

Message

Implements the Message trait for a type.