Struct ModuleData 

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

A struct containing data for multiple signaling modules, each associated with the module’s namespace.

Implementations

impl ModuleData

pub fn new() -> Self

Create a new empty ModuleData.

pub fn iter(&self) -> impl Iterator<Item = (&ModuleId, &Value)>

Get an iterator over all module data entries

pub fn get<T: SignalingModuleFrontendData>(&self) -> Result<Option<T>, Error>

Get the participant data for a specific module

pub fn insert<T: SignalingModuleFrontendData>( &mut self, data: &T, ) -> Result<(), Error>

Set the participant data for a specific module

If an entry with the namespace already exists, it will be overwritten. If the namespace of T is None, the data will not be stored at all.

pub fn contains_key(&self, key: &ModuleId) -> bool

Query whether the module data contains a value for this key

pub fn remove<T: SignalingModuleFrontendData>(&mut self)

Remove an entry by the namespace of SignalingModuleFrontendData type.

This method does not verify that the data actually can be deserialized into the requested types, it just uses its namespace and removes an entry with that namespace if it exists.

pub fn remove_key(&mut self, key: &ModuleId)

Remove an entry by its key if it exists.

pub fn take<T: SignalingModuleFrontendData>( &mut self, ) -> Result<Option<T>, Error>

Take an entry by the namespace of a type.

If the entry is present but can not be deserialized into the requested type, the data will remain unchanged, the entry is not removed.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&ModuleId, &mut Value) -> bool,

Retains only the entries specified by the predicate

Trait Implementations

impl Clone for ModuleData

fn clone(&self) -> ModuleData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ModuleData

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for ModuleData

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

Formats the value using the given formatter.

impl Default for ModuleData

fn default() -> ModuleData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExampleData for ModuleData

fn example_data() -> Self

Get an example instance of the current datatype.

impl PartialEq for ModuleData

fn eq(&self, other: &ModuleData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ModuleData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for ModuleData

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Eq for ModuleData

impl StructuralPartialEq for ModuleData