​
Purpose

Facade over filesystem, network, storage, identity, crypto, and model crates. This page follows the real source shape for Weave Core 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

  • AgentFs — libs/weave-core/src/filesystem/agentfs.rs
  • AgentFsConfig — libs/weave-core/src/filesystem/agentfs.rs
  • AgentFsEntry — libs/weave-core/src/filesystem/agentfs.rs
  • ContentAnnouncement — libs/weave-core/src/network/dht.rs
  • Dht — libs/weave-core/src/network/dht.rs
  • DhtBehaviour — libs/weave-core/src/network/dht.rs
  • DhtConfig — libs/weave-core/src/network/dht.rs
  • DhtStats — libs/weave-core/src/network/dht.rs
  • Did — libs/weave-core/src/identity/mod.rs
  • Diff — libs/weave-core/src/filesystem/diff.rs
  • DiffEntry — libs/weave-core/src/filesystem/diff.rs
  • DiffSummary — libs/weave-core/src/filesystem/diff.rs

​
Example shape

use weave_core::*;

// 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.