Struct AimdThrottledStore 

pub struct AimdThrottledStore { /* private fields */ }

An ObjectStore wrapper that rate-limits operations using per-category token buckets whose fill rates are controlled by AIMD algorithms.

Operations are split into four independent categories:

• read: get, get_opts, get_range, get_ranges, head
• write: put, put_opts, put_multipart, put_multipart_opts, copy, copy_if_not_exists, rename, rename_if_not_exists
• delete: delete
• list: list_with_delimiter

Streaming operations (list, list_with_offset, delete_stream) do not acquire tokens, but observe each yielded item and feed the result back to the AIMD controller so it can adjust the rate for other operations in the same category.

This is not perfect but probably as close as we can get without moving the throttle into the object_store crate itself.

Implementations

impl AimdThrottledStore

pub fn new( target: Arc<dyn ObjectStore>, config: AimdThrottleConfig, ) -> Result<Self>

Trait Implementations

impl Debug for AimdThrottledStore

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

Formats the value using the given formatter.

impl Display for AimdThrottledStore

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

Formats the value using the given formatter.

impl ObjectStore for AimdThrottledStore

fn put_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, bytes: PutPayload, opts: PutOptions, ) -> Pin<Box<dyn Future<Output = OSResult<PutResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save the provided payload to location with the given options

fn put_multipart_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, opts: PutMultipartOptions, ) -> Pin<Box<dyn Future<Output = OSResult<Box<dyn MultipartUpload>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a multipart upload with options

fn get_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, options: GetOptions, ) -> Pin<Box<dyn Future<Output = OSResult<GetResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a get request with options

fn get_ranges<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, location: &'life1 Path, ranges: &'life2 [Range<u64>], ) -> Pin<Box<dyn Future<Output = OSResult<Vec<Bytes>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Return the bytes that are stored at the specified location in the given byte ranges

fn delete_stream( &self, locations: BoxStream<'static, OSResult<Path>>, ) -> BoxStream<'static, OSResult<Path>>

Delete all the objects at the specified locations

fn list( &self, prefix: Option<&Path>, ) -> BoxStream<'static, OSResult<ObjectMeta>>

List all the objects with the given prefix.

fn list_with_offset( &self, prefix: Option<&Path>, offset: &Path, ) -> BoxStream<'static, OSResult<ObjectMeta>>

List all the objects with the given prefix and a location greater than offset

fn list_with_delimiter<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 Path>, ) -> Pin<Box<dyn Future<Output = OSResult<ListResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List objects with the given prefix and an implementation specific delimiter. Returns common prefixes (directories) in addition to object metadata.

fn copy_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, opts: CopyOptions, ) -> Pin<Box<dyn Future<Output = OSResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Copy an object from one path to another in the same object store.

fn rename_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, opts: RenameOptions, ) -> Pin<Box<dyn Future<Output = OSResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move an object from one path to another in the same object store.