Struct socketioxide::extensions::Extensions

pub struct Extensions { /* private fields */ }

Available on crate feature extensions only.

A type map of protocol extensions.

It is heavily inspired by the Extensions type from the http crate.

The main difference is that it uses a DashMap instead of a HashMap to allow concurrent access.

This is necessary because Extensions are shared between all the threads that handle the same socket.

Implementations

impl Extensions

pub fn new() -> Extensions

Create an empty Extensions.

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

Insert a type into this Extensions.

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

Example

let mut ext = Extensions::new();
assert!(ext.insert(5i32).is_none());
assert!(ext.insert(4u8).is_none());
assert_eq!(ext.insert(9i32), Some(5i32));

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

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

Example

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

assert_eq!(*ext.get::<i32>().unwrap(), 5i32);

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

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

Example

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

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

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

Remove a type from this Extensions.

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

Example

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

pub fn clear(&self)

Clear the Extensions of all inserted extensions.

Example

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

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

pub fn is_empty(&self) -> bool

Check whether the extension set is empty or not.

Example

let mut ext = Extensions::new();
assert!(ext.is_empty());
ext.insert(5i32);
assert!(!ext.is_empty());

pub fn len(&self) -> usize

Get the numer of extensions available.

Example

let mut ext = Extensions::new();
assert_eq!(ext.len(), 0);
ext.insert(5i32);
assert_eq!(ext.len(), 1);

Trait Implementations

impl Debug for Extensions

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

Formats the value using the given formatter.

impl Default for Extensions

fn default() -> Extensions

Returns the “default value” for a type.