Struct zng_view_api::display_list::FrameValueId

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

Frame value binding ID.

This ID is defined by the app-process.

See FrameValue for more details.

Implementations

impl FrameValueId

pub const INVALID: Self = _

Dummy ID, zero.

pub const fn first() -> Self

Create the first valid ID.

pub const fn next(self) -> Self

Create the next ID.

IDs wrap around to first when the entire u32 space is used, it is never INVALID.

pub fn incr(&mut self) -> Self

Replace self with next and returns.

pub const fn get(self) -> u64

Get the raw ID.

pub const fn from_raw(id: u64) -> Self

Create an ID using a custom value.

Note that only the documented process must generate IDs, and that it must only generate IDs using this function or the next function.

If the id is zero it will still be INVALID and handled differently by the other process, zero is never valid.

Trait Implementations

impl Clone for FrameValueId

fn clone(&self) -> FrameValueId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameValueId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrameValueId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for FrameValueId

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

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 PartialEq for FrameValueId

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FrameValueId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FrameValueId

impl Eq for FrameValueId

impl StructuralPartialEq for FrameValueId