Module compat

Expand description

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

When importing from the standard library:

always prefer core::<mod> over std::<mod> where it’s available. (e.g. std::fmt::Result -> core::fmt::Result)
use ockam_core::compat::<mod> equivalents where possible. (e.g. std::sync::Arc -> ockam_core::compat::sync::Arc)
if you need to add new items to compat, follow the originating namespace. (e.g. compat::vec::Vec and not compat::Vec)

Modules§

borrow: Provides std::borrow for alloc targets. A module for working with borrowed data.
boxed: Provides std::boxed for alloc targets.
collections: Provides std::collections and alternate hashbrown map and set implementations.
error: Provides a std::error::Error trait.
fmt: Provides core::fmt
future: Provides future::poll_once
io: Traits, helpers, and type definitions for core I/O functionality.
net: Provides std::net. Networking primitives for TCP/UDP communication.
rand: Provides rand.
str: Provides std::str.
string: Provides std::string.
sync: Provides std::sync for std targets.
task: Provides std::task for std targets. Types and Traits for working with asynchronous tasks.
time: Provides std::time for std targets.
vec: Provides std::vec.

format: Provides std::format for alloc targets. Creates a String using interpolation of runtime expressions.