Struct FrameRef 

pub struct FrameRef<'scene> { /* private fields */ }

Borrowed identity and display metadata for one live frame occurrence.

Implementations

impl FrameRef<'_>

pub const fn ordinal(self) -> u32

Returns the one-based source-order position among live frame occurrences.

pub const fn kind(self) -> FrameKind

Returns whether this is an ordinary or magic frame.

impl<'scene> FrameRef<'scene>

pub const fn id(self) -> Option<&'scene str>

Returns the source element ID when it is a non-empty string.

Excalidraw gives every element a unique ID, but a hand-edited or damaged scene can omit or repeat one; the renderer repairs such IDs when it renders, and the ordinal always identifies the occurrence.

pub const fn name(self) -> Option<&'scene str>

Returns the source display name when it was a string.

Trait Implementations

impl<'scene> Clone for FrameRef<'scene>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'scene> Copy for FrameRef<'scene>

impl Debug for FrameRef<'_>

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

Formats the value using the given formatter.

impl Eq for FrameRef<'_>

impl Hash for FrameRef<'_>

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 FrameRef<'_>

Two references are equal when they name the same frame occurrence of the same admitted scene. A clone of a SceneDocument is the same scene; a second parse of the same bytes is not.

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

Equality operator ==.

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

Inequality operator !=.