Struct Extensions

struct Extensions { ... }

A type map of protocol extensions.

Extensions can be used by Request and Response to store extra data derived from the underlying protocol.

Implementations

impl Extensions

fn new() -> Extensions

Create an empty Extensions.

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

Insert a type into this Extensions.

If a extension of this type already existed, it will be returned and replaced with the new one.

Example

# use http::Extensions;
let mut ext = Extensions::new();
assert!(ext.insert(5i32).is_none());
assert!(ext.insert(4u8).is_none());
assert_eq!(ext.insert(9i32), Some(5i32));
fn get<T: Send + Sync + 'static>(self: &Self) -> Option<&T>

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

Example

# use http::Extensions;
let mut ext = Extensions::new();
assert!(ext.get::<i32>().is_none());
ext.insert(5i32);

assert_eq!(ext.get::<i32>(), Some(&5i32));
fn get_mut<T: Send + Sync + 'static>(self: &mut Self) -> Option<&mut T>

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

Example

# use http::Extensions;
let mut ext = Extensions::new();
ext.insert(String::from("Hello"));
ext.get_mut::<String>().unwrap().push_str(" World");

assert_eq!(ext.get::<String>().unwrap(), "Hello World");
fn get_or_insert<T: Clone + Send + Sync + 'static>(self: &mut Self, value: T) -> &mut T

Get a mutable reference to a type, inserting value if not already present on this Extensions.

Example

# use http::Extensions;
let mut ext = Extensions::new();
*ext.get_or_insert(1i32) += 2;

assert_eq!(*ext.get::<i32>().unwrap(), 3);
fn get_or_insert_with<T: Clone + Send + Sync + 'static, F: FnOnce() -> T>(self: &mut Self, f: F) -> &mut T

Get a mutable reference to a type, inserting the value created by f if not already present on this Extensions.

Example

# use http::Extensions;
let mut ext = Extensions::new();
*ext.get_or_insert_with(|| 1i32) += 2;

assert_eq!(*ext.get::<i32>().unwrap(), 3);
fn get_or_insert_default<T: Default + Clone + Send + Sync + 'static>(self: &mut Self) -> &mut T

Get a mutable reference to a type, inserting the type's default value if not already present on this Extensions.

Example

# use http::Extensions;
let mut ext = Extensions::new();
*ext.get_or_insert_default::<i32>() += 2;

assert_eq!(*ext.get::<i32>().unwrap(), 2);
fn remove<T: Send + Sync + 'static>(self: &mut Self) -> Option<T>

Remove a type from this Extensions.

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

Example

# use http::Extensions;
let mut ext = Extensions::new();
ext.insert(5i32);
assert_eq!(ext.remove::<i32>(), Some(5i32));
assert!(ext.get::<i32>().is_none());
fn clear(self: &mut Self)

Clear the Extensions of all inserted extensions.

Example

# use http::Extensions;
let mut ext = Extensions::new();
ext.insert(5i32);
ext.clear();

assert!(ext.get::<i32>().is_none());
fn is_empty(self: &Self) -> bool

Check whether the extension set is empty or not.

Example

# use http::Extensions;
let mut ext = Extensions::new();
assert!(ext.is_empty());
ext.insert(5i32);
assert!(!ext.is_empty());
fn len(self: &Self) -> usize

Get the number of extensions available.

Example

# use http::Extensions;
let mut ext = Extensions::new();
assert_eq!(ext.len(), 0);
ext.insert(5i32);
assert_eq!(ext.len(), 1);
fn extend(self: &mut Self, other: Self)

Extends self with another Extensions.

If an instance of a specific type exists in both, the one in self is overwritten with the one from other.

Example

# use http::Extensions;
let mut ext_a = Extensions::new();
ext_a.insert(8u8);
ext_a.insert(16u16);

let mut ext_b = Extensions::new();
ext_b.insert(4u8);
ext_b.insert("hello");

ext_a.extend(ext_b);
assert_eq!(ext_a.len(), 3);
assert_eq!(ext_a.get::<u8>(), Some(&4u8));
assert_eq!(ext_a.get::<u16>(), Some(&16u16));
assert_eq!(ext_a.get::<&'static str>().copied(), Some("hello"));

impl Clone for Extensions

fn clone(self: &Self) -> Extensions

impl Debug for Extensions

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

impl Default for Extensions

fn default() -> Extensions

impl Freeze for Extensions

impl RefUnwindSafe for Extensions

impl Send for Extensions

impl Sync for Extensions

impl Unpin for Extensions

impl UnsafeUnpin for Extensions

impl UnwindSafe for Extensions

impl<T> Any for Extensions

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for Extensions

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for Extensions

fn borrow_mut(self: &mut Self) -> &mut T

impl<T> CloneToUninit for Extensions

unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)

impl<T> From for Extensions

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for Extensions

fn to_owned(self: &Self) -> T
fn clone_into(self: &Self, target: &mut T)

impl<T, U> Into for Extensions

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for Extensions

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for Extensions

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>