Struct CloneableLayer

pub struct CloneableLayer(/* private fields */);

CloneableLayer allows itself to be cloned. This is useful when a type that implements Clone wishes to store a config layer.

It ensures that all the items in CloneableLayer are Clone upon entry, e.g. when they are first stored, the mutable methods require that they have a Clone bound on them.

While FrozenLayer is also cloneable, which is a shallow clone via Arc, CloneableLayer performs a deep clone that newly allocates all the items stored in it.

Cloneable enforces that non clone items cannot be added

use aws_smithy_types::config_bag::Storable;
use aws_smithy_types::config_bag::StoreReplace;
use aws_smithy_types::config_bag::CloneableLayer;
#[derive(Debug)]
struct MyNotCloneStruct;

impl Storable for MyNotCloneStruct {
    type Storer = StoreReplace<MyNotCloneStruct>;
}
let mut layer = CloneableLayer::new("layer");
layer.store_put(MyNotCloneStruct);

See the module docs for more documentation.

Implementations

impl CloneableLayer

pub fn new(name: impl Into<Cow<'static, str>>) -> Self

Creates a new CloneableLayer with a given name

pub fn freeze(self) -> FrozenLayer

Converts this layer into a frozen layer that can no longer be mutated.

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

Removes T from this bag

pub fn store_put<T>(&mut self, item: T) -> &mut Self

where T: Storable<Storer = StoreReplace<T>> + Clone,

Stores item of type T into the config bag, overriding a previous value of the same type

pub fn store_or_unset<T>(&mut self, item: Option<T>) -> &mut Self

where T: Storable<Storer = StoreReplace<T>> + Clone,

Stores item of type T into the config bag, overriding a previous value of the same type, or unsets it by passing a None

pub fn store_append<T>(&mut self, item: T) -> &mut Self

where T: Storable<Storer = StoreAppend<T>> + Clone,

Stores item of type T into the config bag, appending it to the existing list of the same type

pub fn clear<T>(&mut self)

where T: Storable<Storer = StoreAppend<T>> + Clone,

Clears the value of type T from the config bag

Methods from Deref<Target = Layer>

pub fn is_empty(&self) -> bool

Returns true if this layer is empty.

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

Load a storable item from the bag

Trait Implementations

impl Clone for CloneableLayer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CloneableLayer

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

Formats the value using the given formatter.

impl Default for CloneableLayer

fn default() -> CloneableLayer

Returns the “default value” for a type.

impl Deref for CloneableLayer

type Target = Layer

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<CloneableLayer> for Layer

fn from(cloneable_layer: CloneableLayer) -> Layer

Converts to this type from the input type.