Struct aws_smithy_runtime_api::config_bag::ConfigBag

source ·

pub struct ConfigBag { /* private fields */ }

Expand description

Layered Configuration Structure

ConfigBag is the “unlocked” form of the bag. Only the top layer of the bag may be unlocked.

Implementations§

source §

impl ConfigBag

source

pub fn base() -> Self

source

pub fn store_put<T>(&mut self, item: T) -> &mut Selfwhere T: Storable<Storer = StoreReplace<T>>,

source

pub fn store_or_unset<T>(&mut self, item: Option<T>) -> &mut Selfwhere T: Storable<Storer = StoreReplace<T>>,

source

pub fn store_append<T>(&mut self, item: T) -> &mut Selfwhere T: Storable<Storer = StoreAppend<T>>,

This can only be used for types that use StoreAppend

use aws_smithy_runtime_api::config_bag::{ConfigBag, Storable, StoreAppend, StoreReplace};
let mut bag = ConfigBag::base();
#[derive(Debug, PartialEq, Eq)]
struct Interceptor(&'static str);
impl Storable for Interceptor {
    type Storer = StoreAppend<Interceptor>;
}

bag.store_append(Interceptor("123"));
bag.store_append(Interceptor("456"));

assert_eq!(
    bag.load::<Interceptor>().collect::<Vec<_>>(),
    vec![&Interceptor("456"), &Interceptor("123")]
);

source

pub fn clear<T>(&mut self)where T: Storable<Storer = StoreAppend<T>>,

source

pub fn load<T: Storable>(&self) -> <T::Storer as Store>::ReturnedType<'_>

source

pub fn get<T: Send + Sync + Debug + 'static>(&self) -> Option<&T>

Retrieve the value of type T from the bag if exists

source

pub fn get_mut<T>(&mut self) -> Option<&mut T>where T: Storable<Storer = StoreReplace<T>> + Send + Sync + Debug + Clone + 'static,

Returns a mutable reference to T if it is stored in the top layer of the bag

source

pub fn get_mut_or_default<T>(&mut self) -> &mut Twhere T: Storable<Storer = StoreReplace<T>> + Send + Sync + Debug + Clone + Default + 'static,

Returns a mutable reference to T if it is stored in the top layer of the bag

If T is in a deeper layer of the bag, that value will be cloned and inserted into the top layer
If T is not present in the bag, the Default implementation will be used.

source

pub fn get_mut_or_else<T>(&mut self, default: impl Fn() -> T) -> &mut Twhere T: Storable<Storer = StoreReplace<T>> + Send + Sync + Debug + Clone + 'static,

Returns a mutable reference to T if it is stored in the top layer of the bag

If T is in a deeper layer of the bag, that value will be cloned and inserted into the top layer
If T is not present in the bag, default will be used to construct a new value

source

pub fn put<T: Send + Sync + Debug + 'static>(&mut self, value: T) -> &mut Self

Insert value into the bag

source

pub fn unset<T: Send + Sync + Debug + 'static>(&mut self) -> &mut Self

Remove T from this bag

source

pub fn freeze(self) -> FrozenConfigBag

Freeze this layer by wrapping it in an Arc

This prevents further items from being added to this layer, but additional layers can be added to the bag.

source

pub fn with_fn( self, name: &'static str, next: impl Fn(&mut ConfigBag) ) -> ConfigBag

Add another layer to this configuration bag

Hint: If you want to re-use this layer, call freeze first.

use aws_smithy_runtime_api::config_bag::ConfigBag;
let bag = ConfigBag::base();
let first_layer = bag.with_fn("a", |b: &mut ConfigBag| { b.put("a"); }).freeze();
let second_layer = first_layer.with_fn("other", |b: &mut ConfigBag| { b.put(1i32); });
// The number is only in the second layer
assert_eq!(first_layer.get::<i32>(), None);
assert_eq!(second_layer.get::<i32>(), Some(&1));

// The string is in both layers
assert_eq!(first_layer.get::<&'static str>(), Some(&"a"));
assert_eq!(second_layer.get::<&'static str>(), Some(&"a"));