Struct FrameValueKey 

pub struct FrameValueKey<T> { /* private fields */ }

Unique key of an updatable value in the view-process frame.

Implementations

impl<T> FrameValueKey<T>

pub fn new_unique() -> FrameValueKey<T>

Generates a new unique ID.

pub fn to_wr(self) -> FrameValueId

To view key.

pub fn to_wr_child(self, child_index: u32) -> FrameValueId

To view key with an extra index modifier.

pub fn bind(self, value: T, animating: bool) -> FrameValue<T>

Create a binding with this key.

The animating flag controls if the binding will propagate to webrender, if true webrender frame updates are generated for frame update requests, if false only the display list is patched, a full frame is rendered on frame update requests.

pub fn bind_child( self, child_index: u32, value: T, animating: bool, ) -> FrameValue<T>

Like bind but the key is modified to include the child_index.

pub fn update(self, value: T, animating: bool) -> FrameValueUpdate<T>

Create a value update with this key.

pub fn update_child( self, child_index: u32, value: T, animating: bool, ) -> FrameValueUpdate<T>

Like update but the key is modified to include the child_index.

pub fn bind_var<VT>( self, var: &Var<VT>, map: impl FnOnce(&VT) -> T, ) -> FrameValue<T>

where VT: VarValue,

Create a binding with this key and var.

The map must produce a copy or clone of the frame value.

pub fn bind_var_child<VT>( self, child_index: u32, var: &Var<VT>, map: impl FnOnce(&VT) -> T, ) -> FrameValue<T>

where VT: VarValue,

Like bind_var but the key is modified to include the child_index.

pub fn bind_var_mapped<VT>(&self, var: &Var<VT>, value: T) -> FrameValue<T>

where VT: VarValue,

Create a binding with this key, var and already mapped value.

pub fn bind_var_mapped_child<VT>( &self, child_index: u32, var: &Var<VT>, value: T, ) -> FrameValue<T>

where VT: VarValue,

Like bind_var_mapped but the key is modified to include the child_index.

pub fn update_var<VT>( self, var: &Var<VT>, map: impl FnOnce(&VT) -> T, ) -> Option<FrameValueUpdate<T>>

where VT: VarValue,

Create a value update with this key and var.

pub fn update_var_child<VT>( self, child_index: u32, var: &Var<VT>, map: impl FnOnce(&VT) -> T, ) -> Option<FrameValueUpdate<T>>

where VT: VarValue,

Like update_var but the key is modified to include the child_index.

pub fn update_var_mapped<VT>( self, var: &Var<VT>, value: T, ) -> Option<FrameValueUpdate<T>>

where VT: VarValue,

Create a value update with this key, var and already mapped value.

pub fn update_var_mapped_child<VT>( self, child_index: u32, var: &Var<VT>, value: T, ) -> Option<FrameValueUpdate<T>>

where VT: VarValue,

Like update_var_mapped but the key is modified to include the child_index.

Trait Implementations

impl<T> Clone for FrameValueKey<T>

fn clone(&self) -> FrameValueKey<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for FrameValueKey<T>

where T: Debug,

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

Formats the value using the given formatter.

impl From<FrameValueKey<PxTransform>> for ReferenceFrameId

fn from(value: FrameValueKey<PxTransform>) -> ReferenceFrameId

Converts to this type from the input type.

impl<T> PartialEq for FrameValueKey<T>

fn eq(&self, other: &FrameValueKey<T>) -> 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<T> Copy for FrameValueKey<T>

impl<T> Eq for FrameValueKey<T>