Crate libratman 

libratman

libratman is a core part of the Irdest project, providing shared utilities for ratmand (a routing daemon), ratcat (a messaging tool), and ratctl (a control utility). It includes type definitions, encoding logic, and functions used by these tools and netmod libraries—userspace drivers for network hardware and protocols.

The crate offers two optional features: client and netmod. The client feature enables applications to connect to ratmand via a TCP socket for tasks like address management or message streaming, used by ratctl and ratcat. The netmod feature provides tools for building netmod drivers, handling frame processing and link configuration independently of the router.

If you’re looking at these crate docs you’re most likely interested in writing an application (or integration) for Ratman, which means you should check out the api module!

Re-exports

pub use types::error::BlockError;

pub use types::error::ClientError;

pub use types::error::EncodingError;

pub use types::error::MicroframeError;

pub use types::error::NetmodError;

pub use types::error::NonfatalError;

pub use types::error::RatmanError;

pub use types::error::Result;

pub use types::error::ScheduleError;

pub use futures;

pub use hex;

pub use tokio;

pub use tokio_stream;

pub use tokio_util;

Modules

api

Ratman client API

chunk

Low level data chunking mechanisms and utilities

endpoint

Endpoint abstraction module

frame

Various Frame abstractions for Irdest tools

rt

Shared sync & async runtime utilities

types

API encoding types for Ratman

Functions

elog

Print a log message and exit

env_xdg_config

Get XDG_CONFIG_HOME from the environment

env_xdg_data

Get XDG_DATA_HOME from the environment

generate_space_key

Create a new private/public keypair usable as a Namespace address