module

RNS

Crystal port of the Reticulum Network Stack.

Reticulum is a cryptography-based networking protocol for building reliable, encrypted, and authenticated communications over any available medium. This module provides the complete RNS API including Identity management, Destination addressing, Packet construction, Link establishment, Channel messaging, Resource transfers, and a full suite of network interfaces.

See: https://reticulum.network

Constants

LOG_CALLBACK = 147

LOG_CRITICAL = 0

LOG_DEBUG = 6

LOG_ERROR = 1

LOG_EXTREME = 7

LOG_FILE = 146

LOG_INFO = 4

LOG_MAXSIZE = (5 * 1024) * 1024

Maximum log file size before rotation (5 MB).

LOG_NONE = -1

Log level constants, matching the Python RNS log levels exactly.

LOG_NOTICE = 3

LOG_STDOUT = 145

Log destination constants.

LOG_VERBOSE = 5

LOG_WARNING = 2

VERSION = "0.1.0"

Current version of the Crystal RNS shard.

Class methods

compact_log_fmt

When true, omits the log level tag from output.

compact_log_fmt=(compact_log_fmt : Bool)

When true, omits the log level tag from output.

exit(code : Int32 = 0)

Performs graceful shutdown: saves state, tears down interfaces, then exits.

exit_called?

Returns true if exit has already been called.

hexrep(data : Bytes, delimit : Bool = true) : String

host_os

Returns the host operating system name (e.g. "linux", "darwin").

log(msg, level : Int32 = LOG_NOTICE, _override_destination : Bool = false)

Emits a log message at the given level. The message is routed to stdout, a file, or a callback depending on the current logdest.

logcall

Callback proc invoked for each log line when logdest is LOG_CALLBACK.

logcall=(logcall : Proc(String, Nil) | Nil)

Callback proc invoked for each log line when logdest is LOG_CALLBACK.

logdest

Log destination: LOG_STDOUT, LOG_FILE, or LOG_CALLBACK.

logdest=(logdest : Int32)

Log destination: LOG_STDOUT, LOG_FILE, or LOG_CALLBACK.

logfile

Path to log file when logdest is LOG_FILE.

logfile=(logfile : String | Nil)

Path to log file when logdest is LOG_FILE.

loglevel

Current log level. Messages above this level are suppressed.

loglevel=(loglevel : Int32)

Current log level. Messages above this level are suppressed.

loglevelname(level : Int32) : String

Returns a human-readable label for the given log level.

logtimefmt

Timestamp format string for log output.

logtimefmt=(logtimefmt : String)

Timestamp format string for log output.

panic

phyparams

Prints the physical layer parameters (MTU, MDU, key sizes) to stdout.

precise_timestamp_str(time_s : Float64) : String

Returns a high-precision timestamp string (HH:MM:SS.mmm).

prettydistance(m : Float64, suffix : String = "m") : String

prettyfrequency(hz : Float64, suffix : String = "Hz") : String

prettyhexrep(data : Bytes) : String

prettyshorttime(time : Float64, verbose : Bool = false, compact : Bool = false) : String

prettysize(num : Float64, suffix : String = "B") : String

prettyspeed(num : Float64, suffix : String = "b") : String

prettytime(time : Float64, verbose : Bool = false, compact : Bool = false) : String

rand

timestamp_str(time_s : Float64) : String

Formats a Unix timestamp as a human-readable string using the configured format.

trace_exception(e : Exception)

Logs an unhandled exception with full backtrace at ERROR level.

version

Returns the RNS shard version string.

Nested types