Module docs

Available on crate feature rpc only.

API for document management.

The main entry point is the Client.

Structs

• Client
  Iroh docs client.
• Doc
  Document handle
• Entry
  A single entry in a Replica
• ExportFileOutcome
  Outcome of a Doc::export_file operation
• ExportFileProgress
  Progress stream for Doc::export_file.
• ImportFileOutcome
  Outcome of a Doc::import_file operation
• ImportFileProgress
  Progress stream for Doc::import_file.
• SyncEventengine
  Event emitted when a sync operation completes

Enums

• ImportProgress
  Progress messages for an doc import operation
• LiveEventengine
  Events informing about actions of the live sync progress.
• Originengine
  Why we performed a sync exchange
• ShareMode
  Intended capability for document share tickets
• SyncReasonengine
  Why we started a sync request

Type Aliases

• MemClient
  Type alias for a memory-backed client.