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 extern crate async_trait;

pub use access_control::*;

Modules

Access control

A facade around the various collections and primitives needed to support std, no_std + alloc or no_std targets.

A module to export the error code in a meaningful way

Core types and traits of the Ockam vault.

Macros

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

Structs

A generic address type.

AddressParseError

An error which is returned when address parsing from string fails.

A read-only set containing a Vec of Address structures.

A passthrough marker message type.

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 particular Address

A collection of Mailboxes for a [Context]

A user-defined protocol identifier.

A full route to a peer.

A utility type for building and manipulating routes.

A message wrapper that provides message route information.

TransportMessage

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

AddressParseErrorKind

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 user defined message that can be serialised and deserialized.

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.