Struct async_fetcher::Fetcher

pub struct Fetcher { /* private fields */ }

An asynchronous file fetcher for clients fetching files.

The futures generated by the fetcher are compatible with single and multi-threaded runtimes, allowing you to choose between the runtime that works best for your application. A single-threaded runtime is generally recommended for fetching files, as your network connection is unlikely to be faster than a single CPU core.

Implementations

impl Fetcher

pub fn new(client: Client) -> Self

Constructs a new Fetcher.

impl Fetcher

pub fn cancel(self, value: Arc<AtomicBool>) -> Self

When set, cancels any active operations.

pub fn connections_per_file(self, value: Option<NonZeroU16>) -> Self

The number of concurrent connections to sustain per file being fetched.

pub fn retries(self, value: NonZeroU16) -> Self

The number of attempts to make when a request fails.

pub fn max_part_size(self, value: NonZeroU32) -> Self

The maximum size of a part file when downloading in parts.

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

The time to wait between chunks before giving up.

pub fn events(self, value: impl Into<Arc<EventSender>>) -> Self

Holds a sender for submitting events to.

impl Fetcher

pub fn build(self) -> Arc<Self>

Finalizes the fetcher to prepare it for fetch tasks.

pub fn requests_stream<ExtraType>(
    self: Arc<Self>,
    inputs: impl Stream<Item = (Source, ExtraType)> + Unpin + Send + 'static
) -> impl Stream<Item = impl Future<Output = (Arc<Path>, ExtraType, Result<(), Error>)> + Send + 'static> + Send + Unpin + 'static where
    ExtraType: Send + 'static, 

Build a stream that will perform fetches when polled.

pub async fn request(
    self: Arc<Self>,
    uris: Arc<[Box<str>]>,
    to: Arc<Path>
) -> Result<(), Error>

Request a file from one or more URIs.

At least one URI must be provided as a source for the file. Each additional URI serves as a mirror for failover and load-balancing purposes.

Trait Implementations

impl Default for Fetcher

fn default() -> Self

Returns the “default value” for a type.