Struct aws_smithy_http::property_bag::PropertyBag

pub struct PropertyBag { /* fields omitted */ }

A type-map of configuration data.

PropertyBag can be used by Request and Response to store data used to configure the SDK request pipeline.

TODO: We should consider if we want to require members of the property to be “resettable” in some way to reset any state prior to a retry. I think this is worth delaying until we need it, but is worth keeping in mind.

Implementations

impl PropertyBag

pub fn new() -> PropertyBag

Create an empty PropertyBag.

pub fn insert<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T>

Insert a type into this PropertyBag.

If a value of this type already existed, it will be returned.

Examples

let mut props = PropertyBag::new();

#[derive(Debug, Eq, PartialEq)]
struct Endpoint(&'static str);
assert!(props.insert(Endpoint("dynamo.amazon.com")).is_none());
assert_eq!(
    props.insert(Endpoint("kinesis.amazon.com")),
    Some(Endpoint("dynamo.amazon.com"))
);

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

Get a reference to a type previously inserted on this PropertyBag.

Examples

let mut props = PropertyBag::new();
assert!(props.get::<i32>().is_none());
props.insert(5i32);

assert_eq!(props.get::<i32>(), Some(&5i32));

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

Get a mutable reference to a type previously inserted on this PropertyBag.

Examples

let mut props = PropertyBag::new();
props.insert(String::from("Hello"));
props.get_mut::<String>().unwrap().push_str(" World");

assert_eq!(props.get::<String>().unwrap(), "Hello World");

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

Remove a type from this PropertyBag.

If a value of this type existed, it will be returned.

Examples

let mut props = PropertyBag::new();
props.insert(5i32);
assert_eq!(props.remove::<i32>(), Some(5i32));
assert!(props.get::<i32>().is_none());

pub fn clear(&mut self)

Clear the PropertyBag of all inserted extensions.

Examples

let mut props = PropertyBag::new();
props.insert(5i32);
props.clear();

assert!(props.get::<i32>().is_none());

Trait Implementations

impl Debug for PropertyBag

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

Formats the value using the given formatter.

impl Default for PropertyBag

fn default() -> PropertyBag

Returns the “default value” for a type.

impl From<PropertyBag> for SharedPropertyBag

fn from(bag: PropertyBag) -> Self

Performs the conversion.