Skip to main content

LinkResolver

Struct LinkResolver 

Source
pub struct LinkResolver { /* private fields */ }
Expand description

In-memory resolver and mirror registry.

Implementations§

Source§

impl LinkResolver

Source

pub fn new() -> Self

Create an empty resolver.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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§

Source§

impl Clone for LinkResolver

Source§

fn clone(&self) -> LinkResolver

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinkResolver

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LinkResolver

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

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

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more