Enum ElementId 

pub enum ElementId {
    View(EntityId),
    Integer(u64),
    Name(SharedString),
    Uuid(Uuid),
    FocusHandle(FocusId),
    NamedInteger(SharedString, u64),
    Path(Arc<Path>),
    CodeLocation(Location<'static>),
    NamedChild(Arc<ElementId>, SharedString),
    OpaqueId([u8; 20]),
}

Identifies an element across frames, so that its element state survives re-renders.

Elements that keep state, such as interactive elements and scroll containers, need an id. Build one with .into() from a string, a number, a tuple such as (row, 3), or a FocusHandle. An element’s identity is its path of ids from the root, so an id only needs to be unique among siblings. Use an id that identifies the element’s content, such as a database id, when the element can move within a list.

Examples

let save: ElementId = "save".into();
let row: ElementId = ("row", 3_usize).into();
assert_eq!(save.to_string(), "save");
assert_eq!(row.to_string(), "row-3");

See elements for how ids are used.

Variants

View(EntityId)

The id of a view, made from its EntityId.

Integer(u64)

An integer id, such as a list index.

Name(SharedString)

A string id.

Uuid(Uuid)

A UUID.

FocusHandle(FocusId)

The id of a focus handle, which keeps the element’s focus state.

NamedInteger(SharedString, u64)

A string and an integer, such as ("row", 3).

Path(Arc<Path>)

A file-system path.

CodeLocation(Location<'static>)

A location in source code, captured with #[track_caller].

NamedChild(Arc<ElementId>, SharedString)

A child of another id, labeled by a name, such as the "close" button of a tab.

OpaqueId([u8; 20])

A 20-byte opaque id, used for text anchors.

Implementations

impl ElementId

pub fn named_usize(name: impl Into<SharedString>, integer: usize) -> ElementId

Returns an ElementId::NamedInteger made from name and integer.

It is the same as (name, integer).into() for a usize integer.

Trait Implementations

impl Clone for ElementId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElementId

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

Formats the value using the given formatter.

impl Display for ElementId

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

Formats the value using the given formatter.

impl Eq for ElementId

impl<'a> From<&'a FocusHandle> for ElementId

fn from(handle: &'a FocusHandle) -> Self

Converts to this type from the input type.

impl From<&'static Location<'static>> for ElementId

fn from(location: &'static Location<'static>) -> Self

Converts to this type from the input type.

impl From<&'static str> for ElementId

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

Converts to this type from the input type.

impl From<(&'static str, EntityId)> for ElementId

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

Converts to this type from the input type.

impl From<(&'static str, u32)> for ElementId

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

Converts to this type from the input type.

impl From<(&'static str, u64)> for ElementId

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

Converts to this type from the input type.

impl From<(&'static str, usize)> for ElementId

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

Converts to this type from the input type.

impl<T: Into<SharedString>> From<(ElementId, T)> for ElementId

fn from((id, name): (ElementId, T)) -> Self

Converts to this type from the input type.

impl From<(SharedString, usize)> for ElementId

fn from((name, id): (SharedString, usize)) -> Self

Converts to this type from the input type.

impl From<Arc<Path>> for ElementId

fn from(path: Arc<Path>) -> Self

Converts to this type from the input type.

impl From<Arc<str>> for ElementId

fn from(name: Arc<str>) -> Self

Converts to this type from the input type.

impl From<SharedString> for ElementId

fn from(name: SharedString) -> Self

Converts to this type from the input type.

impl From<String> for ElementId

fn from(name: String) -> Self

Converts to this type from the input type.

impl From<Uuid> for ElementId

fn from(value: Uuid) -> Self

Converts to this type from the input type.

impl From<[u8; 20]> for ElementId

fn from(opaque_id: [u8; 20]) -> Self

Converts to this type from the input type.

impl From<i32> for ElementId

fn from(id: i32) -> Self

Converts to this type from the input type.

impl From<u64> for ElementId

fn from(id: u64) -> Self

Converts to this type from the input type.

impl From<usize> for ElementId

fn from(id: usize) -> Self

Converts to this type from the input type.

impl Hash for ElementId

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 ElementId

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ElementId

impl TryInto<SharedString> for ElementId

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<SharedString>

Performs the conversion.