Struct WidgetId

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

Unique ID of a widget.

Name

IDs are only unique for the same process. You can associate a name with an ID to give it a persistent identifier.

Memory

The internal number is a NonZeroU64, that means that Option<WidgetId> and WidgetId are the same size as u64.

As Hash

The generated internal number has good statistical distribution and can be used as its own hash, although it is not cryptographically safe, as it is simply a sequential counter scrambled using splitmix64.

Static

The unique ID cannot be generated at compile time, but you can use the static_id! macro to declare a lazy static that instantiates the ID.

Implementations

impl WidgetId

pub fn new_unique() -> Self

Generates a new unique ID.

pub fn get(self) -> u64

Retrieve the underlying value.

pub fn sequential(self) -> u64

Un-scramble the underlying value to get the original sequential count number.

If two IDs, id0 and id1 where generated by the same thread then id0.sequential() < id1.sequential().

pub fn from_raw(raw: u64) -> Self

Creates an ID from a raw value.

The value must not be zero, panics if it is, the value must have been provided by get otherwise the ID will not be unique.

pub fn from_sequential(num: u64) -> Self

Creates an ID from a sequential number.

Safety

The value must not be zero, panics if it is, the value must have been provided by sequential otherwise the ID will not be unique.

impl WidgetId

pub fn named(name: impl Into<Txt>) -> Self

Get or generate an ID with associated name.

If the name is already associated with an ID, returns it. If the name is new, generates a new ID and associated it with the name. If name is an empty string just returns a new ID.

pub fn debug_named(name: impl Into<Txt>) -> Self

Calls named in a debug build and new_unique in a release build.

pub fn named_new(name: impl Into<Txt>) -> Result<Self, IdNameError<Self>>

Generate a new ID with associated name.

If the name is already associated with an ID, returns the NameUsed error. If the name is an empty string just returns a new ID.

pub fn name(self) -> Txt

Returns the name associated with the ID or "".

pub fn set_name(self, name: impl Into<Txt>) -> Result<(), IdNameError<Self>>

Associate a name with the ID, if it is not named.

If the name is already associated with a different ID, returns the NameUsed error. If the ID is already named, with a name different from name, returns the AlreadyNamed error. If the name is an empty string or already is the name of the ID, does nothing.

Trait Implementations

impl Clone for WidgetId

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WidgetId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WidgetId

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

Formats the value using the given formatter.

impl From<&'static str> for WidgetId

fn from(name: &'static str) -> Self

Calls WidgetId::named.

impl From<Cow<'static, str>> for WidgetId

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

Calls WidgetId::named.

impl From<String> for WidgetId

fn from(name: String) -> Self

Calls WidgetId::named.

impl From<Txt> for WidgetId

fn from(name: Txt) -> Self

Calls WidgetId::named.

impl From<WidgetId> for AccessNodeId

fn from(id: WidgetId) -> Self

Converts to this type from the input type.

impl From<WidgetId> for CommandScope

fn from(id: WidgetId) -> Self

Converts to this type from the input type.

impl From<char> for WidgetId

fn from(name: char) -> Self

Calls WidgetId::named.

impl Hash for WidgetId

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoVar<AccessNodeId> for WidgetId

type Var = LocalVar<AccessNodeId>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<CommandScope> for WidgetId

type Var = LocalVar<CommandScope>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Option<WidgetId>> for WidgetId

type Var = LocalVar<Option<WidgetId>>

Variable type that will wrap the T value.

fn into_var(self) -> Self::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WidgetId> for &'static str

fn into_var(self) -> Self::Var

Calls WidgetId::named.

type Var = LocalVar<WidgetId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WidgetId> for Cow<'static, str>

fn into_var(self) -> Self::Var

Calls WidgetId::named.

type Var = LocalVar<WidgetId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WidgetId> for String

fn into_var(self) -> Self::Var

Calls WidgetId::named.

type Var = LocalVar<WidgetId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WidgetId> for Txt

fn into_var(self) -> Self::Var

Calls WidgetId::named.

type Var = LocalVar<WidgetId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<WidgetId> for char

fn into_var(self) -> Self::Var

Calls WidgetId::named.

type Var = LocalVar<WidgetId>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for WidgetId

fn eq(&self, other: &Self) -> 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 WidgetId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UniqueId for WidgetId

fn new_unique() -> Self

New unique ID.

impl Copy for WidgetId

impl Eq for WidgetId

impl IntoValue<AccessNodeId> for WidgetId

impl IntoValue<CommandScope> for WidgetId

impl IntoValue<Option<WidgetId>> for WidgetId

impl IntoValue<WidgetId> for &'static str

impl IntoValue<WidgetId> for Cow<'static, str>

impl IntoValue<WidgetId> for String

impl IntoValue<WidgetId> for Txt

impl IntoValue<WidgetId> for char

impl NoUninit for WidgetId

impl PodInOption for WidgetId

impl ZeroableInOption for WidgetId