Skip to main content

GatewayPool

Struct GatewayPool 

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

Ordered pool of IPFS HTTP gateways with hedged failover and per-gateway Fibonacci cooldowns.

Read-only: fetches content and resolves IPNS paths. Publishing, pinning and key management belong to the Kubo client (crate::kubo), never here.

Implementations§

Source§

impl GatewayPool

Source

pub fn public_default() -> Self

Build a public-gateway pool with no localhost probing.

Source

pub fn new(gateway_url: impl Into<String>) -> Self

Build a pool using the caller-provided primary gateway followed by the standard public fallbacks. Localhost is used only if gateway_url itself points at localhost.

Source

pub fn local_first(gateway_url: impl Into<String>) -> Self

Build a local-first pool: localhost, then the caller-provided primary gateway, then the standard public fallbacks.

Source

pub fn gateways(&self) -> &[String]

The ordered gateway URLs this pool will try.

Source

pub fn with_base_cooldown(self, cooldown: Duration) -> Self

Override the base cooldown applied after a gateway failure. The cooldown escalates Fibonacci-style per consecutive failure and resets on success. Duration::ZERO disables cooldowns entirely.

Source

pub fn with_request_timeout(self, timeout: Duration) -> Self

Override the per-request timeout (default 6 seconds). The timeout covers the whole request, connection through body transfer, and is clamped to the time remaining before the operation deadline.

Source

pub fn set_request_timeout(&self, timeout: Option<Duration>)

Update the per-request timeout at runtime. Pass None to revert to the 6-second built-in default.

Source

pub async fn fetch<T>( &self, path: &str, accept: Option<&str>, parse: impl Fn(&[u8]) -> Result<T, String>, ) -> Result<T, String>

GET path from the gateway pool until parse accepts a body.

Gateways are tried in cooldown-filtered order, hedged: a pending attempt that has not answered within HEDGE_DELAY gets the next gateway raced against it and the first parsed success wins. Failing gateways earn an escalating Fibonacci cooldown; the whole operation is bounded by TOTAL_DEADLINE. On total failure the per-gateway errors are joined into one string for the caller to wrap.

Source

pub async fn fetch_bytes( &self, path: &str, accept: Option<&str>, ) -> Result<Vec<u8>, String>

Fetch raw bytes for path (e.g. /ipfs/<cid>) with gateway failover.

Source

pub async fn resolve_ipns_path(&self, path: &str) -> Result<String>

Resolve an /ipns/<name> reference to its current /ipfs/<cid> path.

Reads only gateway response metadata, never the referenced content body. Gateways commonly expose the resolved content path in X-Ipfs-Path; redirects to /ipfs/... are accepted as a fallback. Uses the same hedged failover and cooldowns as GatewayPool::fetch.

Trait Implementations§

Source§

impl Default for GatewayPool

Source§

fn default() -> Self

Build a local-first pool for development and native runtimes.

Source§

impl From<GatewayPool> for IpfsGatewayResolver

Source§

fn from(pool: GatewayPool) -> Self

Converts to this type from the input type.

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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