Iroh

https://docs.rs/iroh-docs/latest/iroh_docs
Admin
Iroh is a distributed system designed for secure and efficient data synchronization and sharing,...
Tokens:591,789
Snippets:5,452
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Basic Iroh-Docs Setup

Source: https://docs.rs/iroh-docs/latest/iroh_docs/index.html?search=u32+-%3E+bool

This snippet shows how to set up an iroh endpoint, initialize Blobs, Gossip, and Docs protocols, and configure a router to accept these protocols. It's a foundational example for starting with iroh-docs.

```rust
use iroh::
{ endpoint::presets, protocol::Router, Endpoint };
use iroh_blobs::{BlobsProtocol, store::mem::MemStore, ALPN as BLOBS_ALPN};
use iroh_docs::{protocol::Docs, ALPN as DOCS_ALPN};
use iroh_gossip::{net::Gossip, ALPN as GOSSIP_ALPN};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // create an iroh endpoint that includes the standard discovery mechanisms
    // we've built at number0
    let endpoint = Endpoint::bind(presets::N0).await?;

    // build the blobs protocol
    let blobs = MemStore::default();

    // build the gossip protocol
    let gossip = Gossip::builder().spawn(endpoint.clone());

    // build the docs protocol
    let docs = Docs::memory()
        .spawn(endpoint.clone(), (*blobs).clone(), gossip.clone())
        .await?;

    // create a router builder, we will add the
    // protocols to this builder and then spawn
    // the router
    let builder = Router::builder(endpoint.clone());

    // setup router
    let _router = builder
        .accept(BLOBS_ALPN, BlobsProtocol::new(&blobs, None))
        .accept(GOSSIP_ALPN, gossip)
        .accept(DOCS_ALPN, docs)
        .spawn();

    // do fun stuff with docs!
    Ok(())
}

```

--------------------------------

### Example Search Queries

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.CreateRequest.html?search=

Illustrative examples of search queries that can be performed. These demonstrate pattern matching and type filtering.

```text
std::vec
```

```text
u32 -> bool
```

```text
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### AcceptOutcome Search Examples

Source: https://docs.rs/iroh-docs/latest/iroh_docs/net/enum.AcceptOutcome.html?search=

Demonstrates various ways to search for AcceptOutcome enum values. These examples cover basic type searches, type-to-type conversions, and more complex generic type manipulations.

```APIDOC
## Search Examples

### Example 1: Basic Type Search

This example shows how to search for a specific type within the AcceptOutcome enum.

```rust
// Example: Search for std::vec
// This would typically involve looking for methods or associated types related to Vec.
std::vec
```

### Example 2: Type Conversion Search

This example demonstrates searching for patterns involving type conversions, such as converting a `u32` to a `bool`.

```rust
// Example: Search for u32 -> bool conversion
// This could represent methods that take a u32 and return a bool, or vice versa.
u32 -> bool
```

### Example 3: Generic Type Manipulation Search

This example illustrates searching for more complex generic type manipulations, like transforming an `Option<T>` using a function that converts `T` to `U`, resulting in an `Option<U>`.

```rust
// Example: Search for Option<T>, (T -> U) -> Option<U>
// This pattern is common in functional programming and data transformation.
Option<T>, (T -> U) -> Option<U>
```
```

--------------------------------

### InsertOrigin Search Examples

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/enum.InsertOrigin.html?search=

Examples demonstrating how to perform searches within the InsertOrigin enum. These examples cover basic searches, type-to-type conversions, and more complex generic type manipulations.

```APIDOC
## Search Examples

### Basic Search

This example shows a simple search for a specific type within the enum.

```apidoc
search("std::vec")
```

### Type Conversion Search

This example demonstrates searching for conversions between types, such as from `u32` to `bool`.

```apidoc
search("u32 -> bool")
```

### Generic Type Manipulation Search

This example illustrates a more complex search involving generic types and function-like transformations, such as `Option<T>, (T -> U) -> Option<U>`.

```apidoc
search("Option<T>, (T -> U) -> Option<U>")
```
```

--------------------------------

### ImportNamespaceOutcome Search Examples

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/enum.ImportNamespaceOutcome.html?search=

Provides examples of how to search for ImportNamespaceOutcome outcomes. These examples demonstrate common search patterns.

```APIDOC
## Search Examples

### Example 1: Searching for a specific type
```
std::vec
```

### Example 2: Searching for a type conversion
```
u32 -> bool
```

### Example 3: Searching for a generic type transformation
```
Option<T>, (T -> U) -> Option<U>
```
```

--------------------------------

### Rust Example Search: Option and Map

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.AuthorImportResponse.html?search=std%3A%3Avec

Example search query demonstrating the use of Option<T> with a function that maps T to U, resulting in Option<U>.

```rust
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### StartSyncRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to start synchronization.

```APIDOC
## Struct StartSyncRequest

### Description
Request to start synchronization.

### Struct Definition
```
struct StartSyncRequest
```
```

--------------------------------

### Rust Example Search: Type Conversion

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.AuthorImportResponse.html?search=std%3A%3Avec

Example search query for type conversions, specifically from u32 to bool.

```rust
u32 -> bool
```

--------------------------------

### StartSyncResponse

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Response after starting synchronization.

```APIDOC
## Struct StartSyncResponse

### Description
Response after starting synchronization.

### Struct Definition
```
struct StartSyncResponse
```
```

--------------------------------

### GetSyncPeersResponse Search Examples

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.GetSyncPeersResponse.html?search=

Examples of how to search for GetSyncPeersResponse structures.

```APIDOC
## GetSyncPeersResponse Search

### Description
This section provides examples for searching GetSyncPeersResponse structures.

### Example Searches
- `std::vec`
- `u32 -> bool`
- `Option<T>, (T -> U) -> Option<U>`
```

--------------------------------

### Basic iroh-docs Setup

Source: https://docs.rs/iroh-docs/latest/iroh_docs/index.html?search=

This snippet demonstrates the initialization of an iroh endpoint and the subsequent setup of Blobs, Gossip, and Docs protocols. It shows how to create an endpoint, configure a memory store for blobs, spawn a gossip protocol instance, and then initialize the Docs protocol with these dependencies. Finally, it configures a router to accept incoming connections for each protocol.

```rust
use iroh::{endpoint::presets, protocol::Router, Endpoint};
use iroh_blobs::{BlobsProtocol, store::mem::MemStore, ALPN as BLOBS_ALPN};
use iroh_docs::{protocol::Docs, ALPN as DOCS_ALPN};
use iroh_gossip::{net::Gossip, ALPN as GOSSIP_ALPN};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // create an iroh endpoint that includes the standard discovery mechanisms
    // we've built at number0
    let endpoint = Endpoint::bind(presets::N0).await?;

    // build the blobs protocol
    let blobs = MemStore::default();

    // build the gossip protocol
    let gossip = Gossip::builder().spawn(endpoint.clone());

    // build the docs protocol
    let docs = Docs::memory()
        .spawn(endpoint.clone(), (*blobs).clone(), gossip.clone())
        .await?;

    // create a router builder, we will add the
    // protocols to this builder and then spawn
    // the router
    let builder = Router::builder(endpoint.clone());

    // setup router
    let _router = builder
        .accept(BLOBS_ALPN, BlobsProtocol::new(&blobs, None))
        .accept(GOSSIP_ALPN, gossip)
        .accept(DOCS_ALPN, docs)
        .spawn();

    // do fun stuff with docs!
    Ok(())
}

```

--------------------------------

### StartSync

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.DocsMessage.html?search=

Starts synchronization with the specified request and protocol.

```APIDOC
## StartSync

### Description
Starts synchronization with the specified request and protocol.

### Method
Not specified (likely a method call in an SDK)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **request** (StartSyncRequest) - The request object for starting synchronization.
- **protocol** (DocsProtocol) - The protocol to use for synchronization.
```

--------------------------------

### Start Sync with Peers

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.Doc.html

Asynchronously initiates synchronization for this document with a list of specified peers.

```rust
pub async fn start_sync(&self, peers: Vec<EndpointAddr>) -> Result<()>
```

--------------------------------

### StartSync

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.DocsMessage.html?search=u32+-%3E+bool

Starts synchronization with channels for the StartSync operation.

```APIDOC
## StartSync

### Description
Starts synchronization with channels for the StartSync operation.

### Method
Not specified (likely SDK method call)

### Endpoint
Not specified

### Parameters
- **request** (StartSyncRequest) - Required - The request object for the StartSync operation.
- **channels** (DocsProtocol) - Required - The channels to use for the operation.
```

--------------------------------

### Get

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.DocsProtocol.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initiates an operation with a GetManyRequest.

```APIDOC
## Get(GetManyRequest)

### Description
Initiates an operation with a GetManyRequest.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Get Default Document Author

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.DocsApi.html?search=

Retrieves the default document author for the node. On persistent nodes, this author is created on first start and its public key is saved.

```rust
pub async fn author_default(&self) -> Result<AuthorId>
```

--------------------------------

### Setting up iroh-docs with iroh

Source: https://docs.rs/iroh-docs/latest/iroh_docs/index.html?search=std%3A%3Avec

This snippet shows how to initialize an iroh endpoint, set up the blobs and gossip protocols, and then spawn the docs protocol and a router. Ensure you have the necessary dependencies for iroh, iroh-blobs, iroh-docs, and iroh-gossip.

```rust
use iroh::{endpoint::presets, protocol::Router, Endpoint};
use iroh_blobs::{BlobsProtocol, store::mem::MemStore, ALPN as BLOBS_ALPN};
use iroh_docs::{protocol::Docs, ALPN as DOCS_ALPN};
use iroh_gossip::{net::Gossip, ALPN as GOSSIP_ALPN};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // create an iroh endpoint that includes the standard discovery mechanisms
    // we've built at number0
    let endpoint = Endpoint::bind(presets::N0).await?;

    // build the blobs protocol
    let blobs = MemStore::default();

    // build the gossip protocol
    let gossip = Gossip::builder().spawn(endpoint.clone());

    // build the docs protocol
    let docs = Docs::memory()
        .spawn(endpoint.clone(), (*blobs).clone(), gossip.clone())
        .await?;

    // create a router builder, we will add the
    // protocols to this builder and then spawn
    // the router
    let builder = Router::builder(endpoint.clone());

    // setup router
    let _router = builder
        .accept(BLOBS_ALPN, BlobsProtocol::new(&blobs, None))
        .accept(GOSSIP_ALPN, gossip)
        .accept(DOCS_ALPN, docs)
        .spawn();

    // do fun stuff with docs!
    Ok(())
}
```

--------------------------------

### take

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/type.ContentStatusCallback.html

Creates an adapter that reads at most a specified number of bytes.

```APIDOC
## fn take(self, limit: u64) -> Take<Self>

### Description
Creates an adapter which will read at most `limit` bytes from it.

### Method
`take`

### Parameters
- `limit` (u64): The maximum number of bytes to read.

### Response
- `Take<Self>`: A `Take` adapter that limits the number of bytes read.
```

--------------------------------

### CapabilityError Search Examples

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/enum.CapabilityError.html?search=

Examples of how to search for CapabilityError enums.

```APIDOC
## Search Examples

### Example 1: Searching for a specific enum

```
std::vec
```

### Example 2: Searching for enums with a specific type signature

```
u32 -> bool
```

### Example 3: Searching for enums with generic types and a transformation

```
Option<T>, (T -> U) -> Option<U>
```
```

--------------------------------

### ReplicaInfo::new

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.ReplicaInfo.html

Creates a new replica instance. This is the entry point for initializing replica-related operations.

```APIDOC
## ReplicaInfo::new

### Description
Creates a new replica.

### Method
`new`

### Parameters
* `capability` (Capability) - The capability required for the replica.

### Returns
A new `ReplicaInfo` instance.
```

--------------------------------

### Get

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.DocsMessage.html?search=u32+-%3E+bool

Retrieves multiple items with channels for the Get operation.

```APIDOC
## Get

### Description
Retrieves multiple items with channels for the Get operation.

### Method
Not specified (likely SDK method call)

### Endpoint
Not specified

### Parameters
- **request** (GetManyRequest) - Required - The request object for the Get operation.
- **channels** (DocsProtocol) - Required - The channels to use for the operation.
```

--------------------------------

### init

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.ImportResponse.html

Initializes a with the given initializer.

```APIDOC
## unsafe fn init(init: <T as Pointable>::Init) -> usize

### Description
Initializes a with the given initializer.

### Safety
This method is unsafe.

### Method
`init`
```

--------------------------------

### Docs Initialization

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Docs.html?search=std%3A%3Avec

Methods for initializing the Docs instance.

```APIDOC
## Docs Initialization

### `new(engine: Engine) -> Self`

Creates a new `Docs` from an `Engine`.
```

--------------------------------

### Rust Example Search: std::vec

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.AuthorImportResponse.html?search=std%3A%3Avec

Example search query for exploring the standard library's vector type.

```rust
std::vec
```

--------------------------------

### Start Sync Engine

Source: https://docs.rs/iroh-docs/latest/iroh_docs/engine/struct.Engine.html

Spawns tokio tasks and a thread to manage live sync coordination, gossip actors, and document storage interaction.

```rust
pub async fn spawn(
    endpoint: Endpoint,
    gossip: Gossip,
    replica_store: Store,
    bao_store: Store,
    downloader: Downloader,
    default_author_storage: DefaultAuthorStorage,
    protect_cb: Option<ProtectCallbackHandler>,
) -> Result<Self>
```

--------------------------------

### Doc::start_sync

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.Doc.html?search=

Initiates synchronization of this document with a list of specified peers.

```APIDOC
## Doc::start_sync

### Description
Starts to sync this document with a list of peers.

### Method
`start_sync(&self, peers: Vec<EndpointAddr>) -> Result<()>`

### Parameters
#### Path Parameters
- `peers` (Vec<EndpointAddr>) - A vector of endpoint addresses of peers to sync with.
```

--------------------------------

### Create Docs from Engine

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Docs.html?search=std%3A%3Avec

Constructs a new Docs instance from a given Engine.

```rust
pub fn new(engine: Engine) -> Self
```

--------------------------------

### Get download policy for a namespace

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html?search=u32+-%3E+bool

Retrieves the currently configured download policy for a given namespace.

```rust
pub fn get_download_policy(
    &mut self,
    namespace: &NamespaceId,
) -> Result<DownloadPolicy>
```

--------------------------------

### Create New Replica

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.Replica.html

Initializes a new Replica instance. Requires a StoreInstance and ReplicaInfo.

```rust
pub fn new(store: StoreInstance<'a>, info: I) -> Self>
```

--------------------------------

### Getting File Metadata with and_then

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/type.RpcResult.html

Demonstrates using `and_then` to chain file system operations, such as getting metadata and then its modification time. This pattern is useful for sequential operations that can fail at any step.

```Rust
use std::{io::ErrorKind, path::Path};

// Note: on Windows "/" maps to "C:\\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());

let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
```

--------------------------------

### Pointable::Init

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.LatestIterator.html

The type for initializers.

```APIDOC
## Pointable::Init

### Description
The type for initializers.

### Associated Type
`type Init = T`
```

--------------------------------

### kind

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/enum.Capability.html?search=std%3A%3Avec

Get the kind of capability.

```APIDOC
## fn kind(&self) -> CapabilityKind

### Description
Get the kind of capability.
```

--------------------------------

### Example Searches

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.DocsApi.html?search=

Demonstrates various ways to perform searches, including searching for specific types, type conversions, and more complex generic operations.

```APIDOC
## Example Searches

### Description
Provides examples of how to query the search API for different use cases.

### Query Parameters
* **query** (string) - Required - The search query string.

### Request Example
```json
{
  "query": "std::vec"
}
```

### Response
#### Success Response (200)
- **results** (array) - A list of matching documentation entries.

#### Response Example
```json
{
  "results": [
    {
      "title": "Vec<T>",
      "path": "std::vec::Vec"
    }
  ]
}
```
```

--------------------------------

### id

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/enum.Capability.html?search=std%3A%3Avec

Get the `NamespaceId` for this `Capability`.

```APIDOC
## fn id(&self) -> NamespaceId

### Description
Get the `NamespaceId` for this `Capability`.
```

--------------------------------

### StatusResponse

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Response after getting status.

```APIDOC
## Struct StatusResponse

### Description
Response after getting status.

### Struct Definition
```
struct StatusResponse
```
```

--------------------------------

### Pointable - init

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.ImportFileProgress.html?search=std%3A%3Avec

Initializes a with the given initializer.

```APIDOC
## unsafe fn init(init: <T as Pointable>::Init) -> usize

### Description
Initializes a with the given initializer.

### Method
`init`

### Parameters
* `init` (`<T as Pointable>::Init`) - The initializer for the type.
```

--------------------------------

### StatusRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to get status.

```APIDOC
## Struct StatusRequest

### Description
Request to get status.

### Struct Definition
```
struct StatusRequest
```
```

--------------------------------

### Create New Document

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.DocsApi.html?search=

Creates a new document.

```rust
pub async fn create(&self) -> Result<Doc>
```

--------------------------------

### Record::timestamp

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.SignedEntry.html?search=std%3A%3Avec

Gets the timestamp of this record.

```APIDOC
## pub fn timestamp(&self) -> u64

### Description
Get the timestamp of this record.

### Method
(Implicitly called via method on SignedEntry's Deref<Target = Record>)

### Parameters
None

### Response
- `u64`: The timestamp of the record.
```

--------------------------------

### Open Namespace

Source: https://docs.rs/iroh-docs/latest/iroh_docs/actor/struct.SyncHandle.html

Opens a specified namespace with given options. Returns a Result indicating success or failure.

```rust
pub async fn open(&self, namespace: NamespaceId, opts: OpenOpts) -> Result<()>
```

--------------------------------

### Import Document from Namespace Capability

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.DocsApi.html?search=

Imports a document from a namespace capability. Sync does not start automatically; use Doc::start_sync.

```rust
pub async fn import_namespace(&self, capability: Capability) -> Result<Doc>
```

--------------------------------

### as_bytes

Source: https://docs.rs/iroh-docs/latest/iroh_docs/struct.NamespacePublicKey.html?search=std%3A%3Avec

Gets the byte representation of the NamespaceId.

```APIDOC
## as_bytes

### Description
Get the byte representation of this `NamespaceId`.

### Method
`as_bytes`

### Response
#### Success Response
- `&[u8; 32]` - A 32-byte array representing the NamespaceId.
```

--------------------------------

### GetSyncPeersResponse

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Response after getting sync peers.

```APIDOC
## Struct GetSyncPeersResponse

### Description
Response after getting sync peers.

### Struct Definition
```
struct GetSyncPeersResponse
```
```

--------------------------------

### GetSyncPeersRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to get sync peers.

```APIDOC
## Struct GetSyncPeersRequest

### Description
Request to get sync peers.

### Struct Definition
```
struct GetSyncPeersRequest
```
```

--------------------------------

### accept

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/type.ContentStatusCallback.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Handles an incoming connection.

```APIDOC
## accept

### Description
Handles an incoming connection.

### Method
`accept`

### Parameters
- `conn`: `Connection` - The incoming `Connection` to handle.

### Response
- `Result<(), AcceptError>` - A result indicating success or failure.
```

--------------------------------

### GetManyRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to get multiple items.

```APIDOC
## Struct GetManyRequest

### Description
Request to get multiple items.

### Struct Definition
```
struct GetManyRequest
```
```

--------------------------------

### GetExactResponse

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Response after getting an exact item.

```APIDOC
## Struct GetExactResponse

### Description
Response after getting an exact item.

### Struct Definition
```
struct GetExactResponse
```
```

--------------------------------

### GetExactRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to get an exact item.

```APIDOC
## Struct GetExactRequest

### Description
Request to get an exact item.

### Struct Definition
```
struct GetExactRequest
```
```

--------------------------------

### Open a replica from the store

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html?search=u32+-%3E+bool

Opens an existing replica from the store using its `NamespaceId`. This involves loading replica information and creating a `Replica` object.

```rust
pub fn open_replica(
    &mut self,
    namespace_id: &NamespaceId,
) -> Result<Replica<'_>, OpenError>
```

--------------------------------

### GetDownloadPolicyResponse

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Response after getting the download policy.

```APIDOC
## Struct GetDownloadPolicyResponse

### Description
Response after getting the download policy.

### Struct Definition
```
struct GetDownloadPolicyResponse
```
```

--------------------------------

### Engine::start_sync

Source: https://docs.rs/iroh-docs/latest/iroh_docs/engine/struct.Engine.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initiates synchronization for a specific document with a list of peers.

```APIDOC
## Engine::start_sync

### Description
Start to sync a document. If `peers` is non-empty, it will both do an initial set-reconciliation sync with each peer, and join an iroh-gossip swarm with these peers to receive and broadcast document updates.

### Method
`async fn start_sync(&self, namespace: NamespaceId, peers: Vec<EndpointAddr>) -> Result<()>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **namespace** (NamespaceId) - The identifier of the document to sync.
- **peers** (Vec<EndpointAddr>) - A list of endpoint addresses of peers to sync with.

### Request Example
None

### Response
#### Success Response (200)
- **()** - Indicates the sync has been initiated successfully.

#### Response Example
None
```

--------------------------------

### GetDownloadPolicyRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to get the download policy.

```APIDOC
## Struct GetDownloadPolicyRequest

### Description
Request to get the download policy.

### Struct Definition
```
struct GetDownloadPolicyRequest
```
```

--------------------------------

### DocsApi::import_and_subscribe

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.DocsApi.html?search=

Imports a document from a ticket, creates a subscription stream for live events, and joins all peers. It returns the Doc and a stream of LiveEvents. The subscription is set up before sync starts, ensuring no events are missed.

```APIDOC
## DocsApi::import_and_subscribe

### Description
Imports a document from a ticket, creates a subscription stream and joins all peers in the ticket.

Returns the `Doc` and a `Stream` of `LiveEvent`s.
The subscription stream is created before the sync is started, so the first call to this method after starting the node is guaranteed to not miss any sync events.

### Method
`async fn`

### Parameters
#### Path Parameters
- `ticket` (DocTicket) - The document ticket to import.

### Returns
- `Result<(Doc, impl Stream<Item = Result<LiveEvent>>)>` - A tuple containing the imported document and a stream of live events.
```

--------------------------------

### AuthorGetDefaultResponse

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Response after getting the default author.

```APIDOC
## Struct AuthorGetDefaultResponse

### Description
Response after getting the default author.

### Struct Definition
```
struct AuthorGetDefaultResponse
```
```

--------------------------------

### Generic TryInto Implementation for OpenOpts

Source: https://docs.rs/iroh-docs/latest/iroh_docs/actor/struct.OpenOpts.html?search=u32+-%3E+bool

Demonstrates a generic TryInto implementation, allowing conversion into types that can be try_from the source type.

```rust
type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

--------------------------------

### AuthorGetDefaultRequest

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html

Request to get the default author.

```APIDOC
## Struct AuthorGetDefaultRequest

### Description
Request to get the default author.

### Struct Definition
```
struct AuthorGetDefaultRequest
```
```

--------------------------------

### Pointable::init

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.LatestIterator.html

Initializes an object with the given initializer.

```APIDOC
## Pointable::init

### Description
Initializes an object with the given initializer.

### Method
`unsafe fn init(init: <T as Pointable>::Init) -> usize`

### Parameters
- `init`: The initializer for the object.

### Returns
A pointer to the initialized object.
```

--------------------------------

### content_len

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.SignedEntry.html?search=u32+-%3E+bool

Gets the total content length of the record.

```APIDOC
## pub fn content_len(&self) -> u64

### Description
Get the content length of the record.

### Method
N/A (Method on struct)

### Parameters
None

### Returns
- `u64`: The content length of the record.
```

--------------------------------

### raw

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/enum.Capability.html?search=std%3A%3Avec

Get the raw representation of this namespace capability.

```APIDOC
## fn raw(&self) -> (u8, [u8; 32])

### Description
Get the raw representation of this namespace capability.
```

--------------------------------

### Docs::new

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Docs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new `Docs` instance from an `Engine`.

```APIDOC
## Docs::new

### Description
Creates a new `Docs` from an `Engine`.

### Method
`new(engine: Engine)`

### Parameters
#### Path Parameters
- **engine** (Engine) - Description: The engine to use for the Docs instance.
```

--------------------------------

### Get

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.DocsMessage.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves multiple resources based on a request.

```APIDOC
## Get

### Description
Retrieves multiple resources based on a request.

### Method
Not specified (likely SDK method call)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **request** (GetManyRequest) - Description of the request object
- **protocol** (DocsProtocol) - Description of the protocol object

### Request Example
```json
{
  "request": "GetManyRequest object",
  "protocol": "DocsProtocol object"
}
```

### Response
#### Success Response
Details of the success response are not specified in the source.

#### Response Example
No example provided.
```

--------------------------------

### take

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.ContentHashesIterator.html?search=

Creates an iterator that yields the first `n` elements.

```APIDOC
## take

### Description
Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner.

### Method
`take(n)`

### Parameters
- **n** (usize) - The maximum number of elements to yield.

### Returns
A `Take` iterator.
```

--------------------------------

### secret_key

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/enum.Capability.html?search=std%3A%3Avec

Get the `NamespaceSecret` of this `Capability`. Will fail if the `Capability` is read only.

```APIDOC
## fn secret_key(&self) -> Result<&NamespaceSecret, ReadOnly>

### Description
Get the `NamespaceSecret` of this `Capability`. Will fail if the `Capability` is read only.
```

--------------------------------

### Example Searches for Iroh Protocol

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.ImportResponse.html?search=

Demonstrates common search patterns within the Iroh protocol, such as searching for specific types like 'std::vec', type conversions like 'u32 -> bool', and functional transformations like 'Option<T>, (T -> U) -> Option<U>'.

```rust
* std::vec
```

```rust
* u32 -> bool
```

```rust
* Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### step_by

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.ImportFileProgress.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Yields every `step`th item.

```APIDOC
## step_by

### Description
Yields every `step`th item.

### Method
`step_by`

### Parameters
- `step`: `usize` - The interval at which to yield items.

### Returns
A `StepBy` stream that yields every `step`th item.
```

--------------------------------

### Get Author ID

Source: https://docs.rs/iroh-docs/latest/iroh_docs/struct.Author.html

Obtains the unique AuthorId for this author.

```rust
pub fn id(&self) -> AuthorId
```

--------------------------------

### Spawn Docs Protocol

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Builder.html?search=

Builds and spawns a `Docs` protocol instance. Requires an `Endpoint`, `BlobsStore`, and `Gossip` protocol as dependencies.

```rust
pub async fn spawn( self, endpoint: Endpoint, blobs: BlobsStore, gossip: Gossip, ) -> Result<Docs>
```

--------------------------------

### Store::snapshot_owned

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets an owned read-only snapshot of the database.

```APIDOC
## Store::snapshot_owned

### Description
Gets an owned read-only snapshot of the database. This opens a new read transaction that won't be reused. It also commits any open write transaction.

### Method
`snapshot_owned(&mut self) -> Result<ReadOnlyTables>`

### Returns
- `Result<ReadOnlyTables>`: A `Result` containing the owned read-only tables or an error.

### Example
```rust
let mut store = iroh_docs::store::fs::Store::memory();
let snapshot = store.snapshot_owned()?;
```
```

--------------------------------

### connect_and_sync

Source: https://docs.rs/iroh-docs/latest/iroh_docs/net/index.html

Connect to a peer and initiate a synchronization of documents.

```APIDOC
## connect_and_sync

### Description
Connect to a peer and sync a replica.

### Method
(Not specified, likely a library function call)

### Endpoint
(Not applicable, library function)

### Parameters
(Not specified in source)

### Request Example
(Not specified in source)

### Response
(Not specified in source)
```

--------------------------------

### Store::get_download_policy

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html

Gets the download policy for a given namespace.

```APIDOC
## Store::get_download_policy

### Description
Get the download policy for a namespace.

### Method
```
pub fn get_download_policy( &mut self, namespace: &NamespaceId, ) -> Result<DownloadPolicy>
```

### Parameters
#### Path Parameters
- **namespace** (`&NamespaceId`) - Required - The namespace to get the policy for.

### Returns
- `Result<DownloadPolicy>`: The download policy or an error.
```

--------------------------------

### CloneToUninit

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.GetDownloadPolicyResponse.html

Provides an unsafe, nightly-only experimental API for performing copy-assignment from self to an uninitialized memory location.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
Performs copy-assignment from `self` to `dest`.

### Method
`unsafe fn`

### Parameters
- **dest** (*mut u8) - Description: Pointer to the destination memory location.

### Remarks
This is a nightly-only experimental API.
```

--------------------------------

### Docs API Access

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Docs.html?search=std%3A%3Avec

Method to get the Docs API.

```APIDOC
## Docs API Access

### `api(&self) -> &DocsApi`

Returns the API for this docs instance.
```

--------------------------------

### Create New DocTicket

Source: https://docs.rs/iroh-docs/latest/iroh_docs/struct.DocTicket.html

Creates a new DocTicket instance with a given capability and a list of peers.

```rust
pub fn new(capability: Capability, peers: Vec<EndpointAddr>) -> Self
```

--------------------------------

### Get Document ID

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.Doc.html

Retrieves the unique identifier for the document.

```rust
pub fn id(&self) -> NamespaceId
```

--------------------------------

### Get

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.DocsMessage.html?search=

Retrieves multiple items with the specified request and protocol.

```APIDOC
## Get

### Description
Retrieves multiple items with the specified request and protocol.

### Method
Not specified (likely a method call in an SDK)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **request** (GetManyRequest) - The request object for retrieving multiple items.
- **protocol** (DocsProtocol) - The protocol to use for retrieval.
```

--------------------------------

### spawn

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Builder.html

Builds a `Docs` protocol instance using the provided `BlobsStore` and `Gossip` protocols.

```APIDOC
## spawn

### Description
Build a `Docs` protocol given a `BlobsStore` and `Gossip` protocol.

### Method

```rust
pub async fn spawn( self, endpoint: Endpoint, blobs: BlobsStore, gossip: Gossip, ) -> Result<Docs>
```

### Parameters

- **endpoint** (Endpoint) - Description for endpoint
- **blobs** (BlobsStore) - Description for blobs
- **gossip** (Gossip) - Description for gossip

### Response

#### Success Response

- **Docs** - The constructed Docs protocol instance.
```

--------------------------------

### Store::new_replica

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new replica for a given namespace.

```APIDOC
## Store::new_replica

### Description
Creates a new replica for the given `namespace` and persists it in the store.

### Method
`new_replica(&mut self, namespace: NamespaceSecret) -> Result<Replica<'_>>`

### Parameters
#### Path Parameters
- **namespace** (`NamespaceSecret`) - The secret key for the namespace.

### Returns
- `Result<Replica<'_>>`: A `Result` containing the new `Replica` instance or an error.

### Example
```rust
// Assuming 'namespace_secret' is a valid NamespaceSecret
// let mut store = ...;
// let replica = store.new_replica(namespace_secret)?;
```
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/enum.AddrInfoOptions.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides the `type_id` method to get the `TypeId` of a type.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Parameters
None

### Returns
- `TypeId`: The unique identifier for the type of `self`.
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/iroh-docs/latest/iroh_docs/actor/struct.OpenOpts.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides the `type_id` method to get the `TypeId` of an object.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Parameters
None

### Returns
`TypeId` - The unique identifier for the type of `self`.
```

--------------------------------

### Replica::new

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.Replica.html

Creates a new Replica instance. A Replica represents a local view of a mutable, synchronizable key-value store.

```APIDOC
## Replica::new

### Description
Create a new replica.

### Method
`new`

### Parameters
- `store`: The underlying store instance.
- `info`: Replica information.

### Returns
A new `Replica` instance.
```

--------------------------------

### stream_position

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/type.ContentStatusCallback.html

Returns the current seek position from the start of the stream.

```APIDOC
## fn stream_position(&mut self) -> Result<u64, Error>

### Description
Returns the current seek position from the start of the stream.

### Method
`stream_position`

### Response
- `Result<u64, Error>`: Ok(current position) or an Error.
```

--------------------------------

### Engine::spawn

Source: https://docs.rs/iroh-docs/latest/iroh_docs/engine/struct.Engine.html

Starts the sync engine by spawning tokio tasks for live sync coordination and gossip actors, and a thread for interacting with document storage.

```APIDOC
## Engine::spawn

### Description
Start the sync engine. This will spawn two tokio tasks for the live sync coordination and gossip actors, and a thread for the actor interacting with doc storage.

### Method
`async fn spawn(
    endpoint: Endpoint,
    gossip: Gossip,
    replica_store: Store,
    bao_store: Store,
    downloader: Downloader,
    default_author_storage: DefaultAuthorStorage,
    protect_cb: Option<ProtectCallbackHandler>,
) -> Result<Self>

### Parameters
* `endpoint` (Endpoint) - The endpoint for the engine.
* `gossip` (Gossip) - The gossip handle.
* `replica_store` (Store) - The store for replica data.
* `bao_store` (Store) - The bao store for blobs.
* `downloader` (Downloader) - The downloader.
* `default_author_storage` (DefaultAuthorStorage) - Storage for the default author.
* `protect_cb` (Option<ProtectCallbackHandler>) - Optional callback handler for protection.

### Response
* `Result<Self>` - A Result containing the spawned Engine instance or an error.
```

--------------------------------

### Rust Blanket Implementations

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.GetExactRequest.html?search=

Demonstrates various blanket implementations for common traits in Rust, such as CloneToUninit, From, Into, and PolicyExt. These examples show how traits are applied to generic types.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
```

```rust
fn type_id(&self) -> TypeId
```

```rust
impl<T> Borrow<T> for T
where T: ?Sized,
```

```rust
fn borrow(&self) -> &T
```

```rust
impl<T> BorrowMut<T> for T
where T: ?Sized,
```

```rust
fn borrow_mut(&mut self) -> &mut T
```

```rust
impl<T> CloneToUninit for T
where T: Clone,
```

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

```rust
impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,
```

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

```rust
impl<T> Instrument for T
```

```rust
fn instrument(self, span: Span) -> Instrumented<Self>
```

```rust
fn in_current_span(self) -> Instrumented<Self>
```

```rust
impl<T, U> Into<U> for T
where U: From<T>,
```

```rust
fn into(self) -> U
```

```rust
impl<T> IntoEither for T
```

```rust
fn into_either(self, into_left: bool) -> Either<Self, Self>
```

```rust
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,
```

```rust
impl<T> Pointable for T
```

```rust
const ALIGN: usize
```

```rust
type Init = T
```

```rust
unsafe fn init(init: <T as Pointable>::Init) -> usize
```

```rust
unsafe fn deref<'a>(ptr: usize) -> &'a T
```

```rust
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
```

```rust
unsafe fn drop(ptr: usize)
```

```rust
impl<T> PolicyExt for T
where T: ?Sized,
```

```rust
fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,
```

```rust
fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,
```

```rust
impl<T> RpcMessage for T
where T: Debug + Serialize + DeserializeOwned + Send + Sync + Unpin + 'static,
```

```rust
impl<T> Same for T
```

```rust
type Output = T
```

```rust
impl<T> ToOwned for T
where T: Clone,
```

```rust
type Owned = T
```

```rust
fn to_owned(&self) -> T
```

```rust
fn clone_into(&self, target: &mut T)
```

```rust
impl<T, U> TryFrom<U> for T
where U: Into<T>,
```

```rust
type Error = Infallible
```

```rust
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
```

```rust
impl<T, U> TryInto<U> for T
where U: TryFrom<T>,
```

```rust
type Error = <U as TryFrom<T>>::Error
```

```rust
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
```

```rust
impl<T> WithSubscriber for T
```

```rust
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,
```

```rust
fn with_current_subscriber(self) -> WithDispatch<Self>
```

--------------------------------

### Arc<T> Drop Behavior Example

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/type.ContentStatusCallback.html?search=std%3A%3Avec

Demonstrates how the Drop implementation for Arc<T> decrements the strong reference count and drops the inner value when the count reaches zero. This example shows that dropping the original Arc does not trigger the inner Drop implementation, but dropping the cloned Arc does.

```rust
use std::sync::Arc;

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo  = Arc::new(Foo);
let foo2 = Arc::clone(&foo);

drop(foo);    // Doesn't print anything
drop(foo2);   // Prints "dropped!"

```

--------------------------------

### Get Replica Capability

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.Replica.html

Returns a reference to the Capability associated with this Replica.

```rust
pub fn capability(&self) -> &Capability
```

--------------------------------

### Import Document and Subscribe to Events

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.DocsApi.html?search=

Imports a document from a ticket, creates a subscription stream for LiveEvents, and joins all peers. The stream is created before sync starts, ensuring no events are missed.

```rust
pub async fn import_and_subscribe( &self, ticket: DocTicket, ) -> Result<(Doc, impl Stream<Item = Result<LiveEvent>>)>
```

--------------------------------

### Store::get_exact

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets a specific entry by key, author, and namespace.

```APIDOC
## Store::get_exact

### Description
Retrieves a specific entry from the store using its `namespace`, `author`, and `key`. The `include_empty` flag determines if entries with empty content should be returned.

### Method
`get_exact(&mut self, namespace: NamespaceId, author: AuthorId, key: impl AsRef<[u8]>, include_empty: bool) -> Result<Option<SignedEntry>>`

### Parameters
#### Path Parameters
- **namespace** (`NamespaceId`) - The ID of the namespace.
- **author** (`AuthorId`) - The ID of the author.
- **key** (`impl AsRef<[u8]>`) - The key of the entry.
- **include_empty** (`bool`) - Whether to include entries with empty content.

### Returns
- `Result<Option<SignedEntry>>`: A `Result` containing an `Option` with the `SignedEntry` if found, or an error.

### Example
```rust
// Assuming 'namespace_id', 'author_id', and 'key' are valid
// let mut store = ...;
// let entry_option = store.get_exact(namespace_id, author_id, key, false)?;
```
```

--------------------------------

### connect_and_sync

Source: https://docs.rs/iroh-docs/latest/iroh_docs/net/fn.connect_and_sync.html?search=u32+-%3E+bool

Connect to a peer and sync a replica. This function establishes a connection to a specified endpoint and synchronizes data using the provided SyncHandle and NamespaceId. It can optionally accept metrics for monitoring.

```APIDOC
## connect_and_sync

### Description
Connect to a peer and sync a replica.

### Function Signature
```rust
pub async fn connect_and_sync(
    endpoint: &Endpoint,
    sync: &SyncHandle,
    namespace: NamespaceId,
    peer: EndpointAddr,
    metrics: Option<&Metrics>,
) -> Result<SyncFinished, ConnectError>
```

### Parameters

*   `endpoint`: A reference to the `Endpoint`.
*   `sync`: A reference to the `SyncHandle`.
*   `namespace`: The `NamespaceId` to sync.
*   `peer`: The `EndpointAddr` of the peer to connect to.
*   `metrics`: An optional reference to `Metrics` for monitoring.
```

--------------------------------

### Store::get_many

Source: https://docs.rs/iroh-docs/latest/iroh_docs/store/fs/struct.Store.html

Gets an iterator over entries of a replica, based on a query.

```APIDOC
## Store::get_many

### Description
Get an iterator over entries of a replica.

### Method
```
pub fn get_many( &mut self, namespace: NamespaceId, query: impl Into<Query>, ) -> Result<QueryIterator>
```

### Parameters
#### Path Parameters
- **namespace** (NamespaceId) - Required - The namespace of the replica.
- **query** (impl Into<Query>) - Required - The query to filter entries.

### Returns
- `Result<QueryIterator>`: An iterator over the matching entries or an error.
```

--------------------------------

### OpenOpts Struct

Source: https://docs.rs/iroh-docs/latest/iroh_docs/actor/struct.OpenOpts.html?search=u32+-%3E+bool

The OpenOpts struct provides configuration options when opening a replica. It allows setting synchronization state and subscribing to replica events.

```APIDOC
## Struct OpenOpts

### Description
Options when opening a replica.

### Fields
* `sync` (bool) - Set to true to set sync state to true.
* `subscribe` (Option<Sender<Event>>) - Optionally subscribe to replica events.

### Methods
* `sync(self) -> Self`: Set sync state to true.
* `subscribe(self, subscribe: Sender<Event>) -> Self`: Subscribe to replica events.
```

--------------------------------

### Get Download Policy

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/struct.Doc.html

Retrieves the current download policy for this document.

```rust
pub async fn get_download_policy(&self) -> Result<DownloadPolicy>
```

--------------------------------

### Docs::import_and_subscribe

Source: https://docs.rs/iroh-docs/latest/iroh_docs/protocol/struct.Docs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Imports a document from a ticket, creates a subscription stream for `LiveEvent`s, and joins all peers in the ticket. Returns the `Doc` and a `Stream` of `LiveEvent`s. The subscription stream is created before sync starts, ensuring no sync events are missed on the first call after node startup.

```APIDOC
## Docs::import_and_subscribe

### Description
Imports a document from a ticket, creates a subscription stream and joins all peers in the ticket. Returns the `Doc` and a `Stream` of `LiveEvent`s. The subscription stream is created before the sync is started, so the first call to this method after starting the node is guaranteed to not miss any sync events.

### Method
`import_and_subscribe(ticket: DocTicket)`

### Parameters
#### Path Parameters
- **ticket** (DocTicket) - Description: The ticket to import the document from.

### Returns
`Result<(Doc, impl Stream<Item = Result<LiveEvent>>)>`
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/struct.AuthorSetDefaultResponse.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides the `type_id` method to get the `TypeId` of a trait object.

```APIDOC
## fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`.
```

--------------------------------

### DocTicket::new

Source: https://docs.rs/iroh-docs/latest/iroh_docs/struct.DocTicket.html?search=

Creates a new DocTicket instance with a specified capability and a list of peer addresses.

```APIDOC
## DocTicket::new

### Description
Creates a new DocTicket instance with a specified capability and a list of peer addresses.

### Signature
`pub fn new(capability: Capability, peers: Vec<EndpointAddr>) -> Self`

### Parameters
* `capability`: The capability (public or private key) for the document.
* `peers`: A vector of `EndpointAddr` representing nodes to contact.
```

--------------------------------

### Get Subscriber Count

Source: https://docs.rs/iroh-docs/latest/iroh_docs/sync/struct.ReplicaInfo.html

Returns the current number of event subscribers for the replica.

```rust
pub fn subscribers_count(&self) -> usize
```

--------------------------------

### Import Progress and Share Mode

Source: https://docs.rs/iroh-docs/latest/iroh_docs/api/protocol/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Provides documentation for import progress states and sharing modes.

```APIDOC
## ImportProgress

### Description
Progress status during import operations.

## ShareMode

### Description
Defines the mode for sharing documents.
```
Tokens:
Raw