​
Purpose

Peer discovery, mutable records, DID envelopes, local relay sessions, adapter registry, record stores, and handles. This page follows the real source shape for Weave Dht and explains the workflow a developer is likely to use first.

​
Storage contract

Document persistence format, integrity checks, read/write ordering, idempotency, compaction or repair behavior, and how callers recover from partial failures. This section should answer what data is durable and what can be reconstructed.

​
Primary types to know

  • AdapterRegistry — network/weave-dht/src/methods.rs
  • AnnouncementState — network/weave-dht/src/weave.rs
  • AnnounceOpts — network/weave-dht/src/weave.rs
  • DhtClient — network/weave-dht/src/lib.rs
  • DhtConfig — network/weave-dht/src/lib.rs
  • DhtHandle — network/weave-dht/src/lib.rs
  • DhtMethodAdapter — network/weave-dht/src/methods.rs
  • DhtNode — network/weave-dht/src/lib.rs
  • DhtNodeBuilder — network/weave-dht/src/lib.rs
  • DidEnvelope — network/weave-dht/src/envelope.rs
  • EnhancedDhtNode — network/weave-dht/src/enhanced.rs
  • MarsAdapter — network/weave-dht/src/methods.rs

​
Example shape

use weave_dht::*;

// Minimal example skeleton. Replace placeholders with the concrete constructor
// listed on the API Surface page for this library.
async fn example() -> Result<(), Box<dyn std::error::Error>> {
    // 1. Build config or open storage.
    // 2. Execute one operation from this page.
    // 3. Assert the observable result before wiring peers or persistence.
    Ok(())
}

​
Release-quality documentation checklist

  • Every public type on the API Surface page has at least one sentence of behavior documentation.
  • Every fallible operation lists errors and recovery guidance.
  • Every networked example names the peer/session/topic lifecycle.
  • Every storage example names durability, repair, and deletion semantics.