Struct zng::widget::builder::PropertyId

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

Unique ID of a property implementation.

Memory

The internal number is a NonZeroU32, that means that Option<PropertyId> and PropertyId are the same size as u32.

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 a modified 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 PropertyId

pub fn new_unique() -> PropertyId

Generates a new unique ID.

pub fn get(self) -> u32

Retrieve the underlying value.

pub fn sequential(self) -> u32

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: u32) -> PropertyId

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: u32) -> PropertyId

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.

Trait Implementations

impl Clone for PropertyId

fn clone(&self) -> PropertyId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyId

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

Formats the value using the given formatter.

impl Hash for PropertyId

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 InspectPropertyPattern for PropertyId

fn matches(&self, args: &dyn PropertyArgs, _: bool) -> bool

Returns true if the pattern includes the property.

impl PartialEq for PropertyId

fn eq(&self, other: &PropertyId) -> 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 UniqueId for PropertyId

fn new_unique() -> PropertyId

New unique ID.

impl Copy for PropertyId

impl Eq for PropertyId

impl NoUninit for PropertyId

impl PodInOption for PropertyId

impl ZeroableInOption for PropertyId