Struct egui::UiTags

pub struct UiTags(pub HashMap<String, Option<Arc<dyn Any + Send + Sync + 'static>>>);

User-chosen tags.

You can use this in any way you want, i.e. to set some tag on a crate::Ui and then in your own widget check for the existence of this tag up the UiStack.

Note that egui never sets any tags itself, so this is purely for user code.

All tagging is transient, and will only live as long as the parent crate::Ui, i.e. within a single render frame.

Tuple Fields

0: HashMap<String, Option<Arc<dyn Any + Send + Sync + 'static>>>

Implementations

impl UiTags

pub fn insert( &mut self, key: impl Into<String>, value: Option<Arc<dyn Any + Send + Sync + 'static>>, )

pub fn contains(&self, key: &str) -> bool

pub fn get_any( &self, key: &str, ) -> Option<&Arc<dyn Any + Send + Sync + 'static>>

Get the value of a tag.

Note that None is returned both if the key is set to the value None, and if the key is not set at all.

pub fn get_downcast<T: Any + Send + Sync + 'static>( &self, key: &str, ) -> Option<&T>

Get the value of a tag.

Note that None is returned both if the key is set to the value None, and if the key is not set at all.

Trait Implementations

impl Clone for UiTags

fn clone(&self) -> UiTags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UiTags

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

Formats the value using the given formatter.

impl Default for UiTags

fn default() -> UiTags

Returns the “default value” for a type.