aws_smithy_types::config_bag

Struct ConfigBag

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

Layered configuration structure

See the module docs for more documentation.

Implementations§

Source§

impl ConfigBag

Source

pub fn base() -> Self

Create a new config bag “base”.

Source

pub fn of_layers(layers: impl IntoIterator<Item = Layer>) -> Self

Create a ConfigBag consisting of the given layers.

Source

pub fn push_layer(&mut self, layer: Layer) -> &mut Self

Add the given layer to the config bag.

Source

pub fn push_shared_layer(&mut self, layer: FrozenLayer) -> &mut Self

Add a frozen/shared layer to the config bag.

Source

pub fn interceptor_state(&mut self) -> &mut Layer

Return a reference to the mutable interceptor state.

Source

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

Load a value (or values) of type T depending on how T implements Storable

Source

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

Return 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 T
where 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 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

  • 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 with_fn( self, name: impl Into<Cow<'static, str>>, next: impl Fn(&mut Layer), ) -> ConfigBag

Add another layer to this configuration bag

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

§Examples
use aws_smithy_types::config_bag::{ConfigBag, Layer, Storable, StoreReplace};

#[derive(Debug, Eq, PartialEq)]
struct ExampleStr(&'static str);
impl Storable for ExampleStr {
    type Storer = StoreReplace<Self>;
}

#[derive(Debug, Eq, PartialEq)]
struct ExampleInt(i32);
impl Storable for ExampleInt {
    type Storer = StoreReplace<Self>;
}

let mut bag = ConfigBag::base();
bag = bag.with_fn("first", |layer: &mut Layer| { layer.store_put(ExampleStr("a")); });

// We can now load the example string out
assert_eq!(bag.load::<ExampleStr>(), Some(&ExampleStr("a")));

// But there isn't a number stored in the bag yet
assert_eq!(bag.load::<ExampleInt>(), None);

// Add a layer with an example int
bag = bag.with_fn("second", |layer: &mut Layer| { layer.store_put(ExampleInt(1)); });

// Now the example int can be retrieved
assert_eq!(bag.load::<ExampleInt>(), Some(&ExampleInt(1)));
Source

pub fn add_layer(self, name: impl Into<Cow<'static, str>>) -> ConfigBag

Add a new layer with name after freezing the top layer so far

Source

pub fn sourced_get<T: Store>(&self) -> T::ReturnedType<'_>

Return a value (or values) of type T depending on how it has been stored in a ConfigBag

It flexibly chooses to return a single value vs. an iterator of values depending on how T implements a Store trait.

Trait Implementations§

Source§

impl Debug for ConfigBag

Source§

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

Formats the value using the given formatter. Read more

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.