Struct FileScheduler

pub struct FileScheduler { /* private fields */ }

A throttled file reader

Implementations

impl FileScheduler

pub fn submit_request( &self, request: Vec<Range<u64>>, priority: u64, ) -> impl Future<Output = Result<Vec<Bytes>>> + Send

Submit a batch of I/O requests to the reader

The requests will be queued in a FIFO manner and, when all requests have been fulfilled, the returned future will be completed.

Each request has a given priority. If the I/O loop is full then requests will be buffered and requests with the lowest priority will be released from the buffer first.

Each request has a backpressure ID which controls which backpressure throttle is applied to the request. Requests made to the same backpressure throttle will be throttled together.

pub fn submit_single( &self, range: Range<u64>, priority: u64, ) -> impl Future<Output = Result<Bytes>> + Send

Submit a single IOP to the reader

If you have multiple IOPS to perform then Self::submit_request is going to be more efficient.

See Self::submit_request for more information on the priority and backpressure.

pub fn reader(&self) -> &Arc<dyn Reader>

Provides access to the underlying reader

Do not use this for reading data as it will bypass any I/O scheduling! This is mainly exposed to allow metadata operations (e.g size, block_size,) which either aren’t IOPS or we don’t throttle

Trait Implementations

impl Clone for FileScheduler

fn clone(&self) -> FileScheduler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileScheduler

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

Formats the value using the given formatter.