Framing

Purpose

Noise-style secret stream with handshakes, framing, bridge IO, tunables, metrics, and typed errors.

This page follows the real source shape for Zer0 Secret Stream and explains the workflow a developer is likely to use first.

Developer workflow

Start from the smallest constructor or builder, perform one meaningful operation, inspect the returned state, then add the relevant policy, storage, or network integration. The examples below should be expanded whenever the crate API changes.

Primary types to know

• Bridge — network/zer0-secret-stream/src/bridge.rs
• BridgeReverse — network/zer0-secret-stream/src/bridge.rs
• Handshake — network/zer0-secret-stream/src/handshake.rs
• HandshakeResult — network/zer0-secret-stream/src/handshake.rs
• Message — network/zer0-secret-stream/src/lib.rs
• SecretOptions — network/zer0-secret-stream/src/lib.rs
• SecretStream — network/zer0-secret-stream/src/lib.rs
• SecretStreamMetrics — network/zer0-secret-stream/src/metrics.rs
• SecretStreamMetricsSnapshot — network/zer0-secret-stream/src/metrics.rs
• SecretTunables — network/zer0-secret-stream/src/config.rs
• HandshakeError — network/zer0-secret-stream/src/handshake.rs
• HandshakePattern — network/zer0-secret-stream/src/handshake.rs

Example shape

use tokio::io::{AsyncReadExt, AsyncWriteExt};
use zer0_secret_stream::{Message, SecretOptions, SecretStream};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // The framing layer prefixes every Message with its length and per-frame
    // nonce. Reads block until a full frame arrives, so partial network reads
    // are buffered transparently.
    let (alice_inner, bob_inner) = tokio::io::duplex(64 * 1024);
    let mut alice = SecretStream::new(alice_inner, true, SecretOptions::default())?;
    let mut bob = SecretStream::new(bob_inner, false, SecretOptions::default())?;

    let outbound = Message::data(b"hello, bob".to_vec());
    alice.send(outbound).await?;

    let mut buf = [0u8; 1024];
    let n = bob.read(&mut buf).await?;
    println!("bob_received_bytes={} alice_state={:?}", n, alice.state());
    Ok(())
}