Packets and Links

Purpose

Experimental transport/runtime stack composed from filament core, crypto, link, packet, transport, types, interfaces, and utilities.

This page follows the real source shape for Filament 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

• Announce — filament/filament-transport/src/announce.rs
• AnnounceManager — filament/filament-transport/src/announce.rs
• AnnounceQueue — filament/filament-transport/src/announce.rs
• AutoInterface — filament/filament-interfaces/src/auto.rs
• AutoInterfaceBuilder — filament/filament-interfaces/src/auto.rs
• AutoInterfaceConfig — filament/filament-interfaces/src/auto.rs
• BandwidthManager — filament/filament-transport/src/bandwidth.rs
• Channel — filament/filament-link/src/channel.rs
• ChannelMessage — filament/filament-link/src/channel.rs
• Config — filament/filament-core/src/config.rs
• DestinationHash — filament/filament-transport/src/types.rs
• DestinationHash — filament/filament-types/src/primitives.rs

Example shape

use filament_link::{Identity, Link, LinkOptions, LinkState};
use filament_packet::{Header, Packet, PacketValidator};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Build a Packet via its Header. The PacketValidator enforces version,
    // length, and HMAC invariants the routing engine relies on.
    let header = Header::new_data();
    let packet = Packet::new(header, b"payload".to_vec());
    let validator = PacketValidator::default();
    validator.validate(&packet)?;

    // Open a Link to a destination identity. The session moves through
    // Pending -> Active -> Closed states as the proof exchange completes.
    let local = Identity::generate();
    let remote = Identity::generate();
    let link = Link::open(local, remote.address(), LinkOptions::default()).await?;
    println!(
        "packet_ok=true link_id={} state={:?}",
        link.id(),
        link.state(),
    );
    let _ = LinkState::Active;
    Ok(())
}