Struct LinkResolver 

pub struct LinkResolver { /* private fields */ }

In-memory resolver and mirror registry.

Implementations

impl LinkResolver

pub fn new() -> Self

Create an empty resolver.

pub fn with_provider_fetch(fetch: ProviderFetch) -> Self

Create a resolver with a provider fetch hook for network resolution.

The fetch function is called when a name link cannot be resolved locally, allowing the caller to query remote peers via iroh-docs.

pub async fn resolve_remote( &self, link: &Link, ) -> Result<Option<LinkResolution>>

Attempt to resolve a name link by querying remote peers.

Returns None if no provider fetch hook is registered or the link is not a name link. The caller is responsible for falling back to local resolution.

Errors

Returns an error if the remote fetch fails.

pub fn with_database(database: IndexingDatabase) -> Result<Self>

Create a resolver backed by an indexing database.

Pointers and mirrors are hydrated from the database on construction. Mutations are persisted through the database.

Errors

Returns an error if the database cannot be read.

pub fn register_mirror(&self, ticket: BlobTicket) -> Result<()>

Register a direct mirror ticket for a hash.

Errors

Returns an error if the ticket is malformed.

pub fn mirrors(&self, hash: Hash) -> Result<Vec<BlobTicket>>

Return registered direct mirror tickets in registration order.

Errors

Returns an error if the resolver state lock is poisoned.

pub fn publish(&self, pointer: &MutablePointer) -> Result<()>

Accept a signed mutable pointer, enforcing monotonic sequence.

Errors

Returns an error if the pointer is unsigned, invalid, or older than the current pointer.

pub fn current_pointer(&self, link: &NameLink) -> Result<Option<MutablePointer>>

Return the current pointer for a mutable name.

Errors

Returns an error if the link is invalid or the resolver state lock is poisoned.

pub fn revoke(&self, link: &PrivateLink) -> Result<()>

Revoke a private capability.

Errors

Returns an error if the link is invalid or the resolver state lock is poisoned.

pub fn is_revoked(&self, link: &PrivateLink) -> Result<bool>

Return whether a private capability has been revoked.

Errors

Returns an error if the link is invalid or the resolver state lock is poisoned.

pub fn resolve(&self, link: &Link) -> Result<LinkResolution>

Resolve a link using the current time.

Errors

Returns an error if the link is invalid, unavailable, expired, revoked, or has an invalid provider.

pub fn resolve_at(&self, link: &Link, now: u64) -> Result<LinkResolution>

Resolve a link at an explicit timestamp.

Errors

Returns an error if the link is invalid, unavailable, expired, revoked, or has an invalid provider.

pub fn resolve_version( &self, link: &NameLink, version: &str, ) -> Result<LinkResolution>

Resolve a mutable link to an exact semantic version.

Errors

Returns an error if the link or requested version is unavailable.

pub fn resolve_with_options( &self, link: &Link, options: &ResolveOptions, ) -> Result<LinkResolution>

Resolve a link using explicit version and expiry options.

Errors

Returns an error if the link is invalid, unavailable, expired, revoked, or has an invalid provider.

pub fn resolve_uri(&self, uri: &str) -> Result<LinkResolution>

Parse and resolve a link URI.

Errors

Returns an error if the URI cannot be parsed or the link cannot be resolved.

pub fn fetch_with_mirrors<T, Fetch>( &self, link: &Link, fetch: Fetch, ) -> Result<T>

where Fetch: FnMut(&BlobTicket) -> Result<T>,

Resolve and fetch a link, trying each provider and mirror in order.

Errors

Returns the first successful fetch result, or an error if resolution fails or every provider fails.

Trait Implementations

impl Clone for LinkResolver

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LinkResolver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LinkResolver

fn default() -> Self

Returns the “default value” for a type.