Struct UiFrame

Source

pub struct UiFrame { /* private fields */ }

Available on crate feature ui only.

Expand description

▦ Immediate UI frame context.

^{📍 ui/frame::UiFrame}

^{📦 size_of::<UiFrame>() == 12 bytes / 96 bits #️⃣ #[cfg(pointer_target_width = “32”)]} ^{⚗️Option<T> 🟰 T}

^{📦 size_of::<UiFrame>() == 16 bytes / 128 bits #️⃣ #[cfg(pointer_target_width = “64”)]} ^{⚗️Option<T> 🟰 T}

Implementations§

Source §

impl UiFrame

Source

pub const fn new() -> Self

Constructs a frame at the root scope and initial phase.

Source

pub const fn from_parts(phase: UiPhase, scope: UiScope) -> Self

Constructs a frame from its phase and scope.

Source

pub const fn phase(&self) -> UiPhase

Returns the current UI frame phase.

Source

pub const fn scope(&self) -> UiScope

Returns the current identity scope.

Source

pub const fn with_phase(self, phase: UiPhase) -> Self

Returns this frame with a different phase.

Source

pub const fn with_scope(self, scope: UiScope) -> Self

Returns this frame with a different identity scope.

Source

pub const fn id(&self, key: UiKey) -> UiId

Resolves a key inside this frame’s current scope.

Source

pub const fn enter(self, key: UiKey) -> Self

Returns this frame inside a child scope resolved from key.

Trait Implementations§

Source §

impl Clone for UiFrame

Source §

fn clone(&self) -> UiFrame

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Copy for UiFrame

Source §

impl Debug for UiFrame

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for UiFrame

Source §

fn default() -> UiFrame

Returns the “default value” for a type. Read more

Source §

impl Eq for UiFrame

Source §

impl Hash for UiFrame

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl PartialEq for UiFrame

Source §

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for UiFrame

Auto Trait Implementations§

§

impl UnwindSafe for UiFrame

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> AnyExt for T
where T: Any + ?Sized,

Source §

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

Source §

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

Source §

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

Source §

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

Source §

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

Source §

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

Source §

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

Source §

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

Source §

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Available on crate feature alloc only.

Upcasts Box<self> as Box<dyn Any>. Read more

Source §

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout and non-crate feature safe_code only.

Returns some shared reference to the inner value if it is of type T. Read more

Source §

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout and non-crate feature safe_code only.

Returns some exclusive reference to the inner value if it is of type T. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> ByteSized for T

Source §

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

Source §

const BYTE_SIZE: usize = _

The size of this type in bytes.

Source §

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

Source §

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

Source §

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Hook for T

Source §

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Hooks a mutation step into the value and returns it. Read more

Source §

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Taps into the value for observation and returns it unchanged. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> MemExt for T
where T: ?Sized,

Source §

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

Source §

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

Source §

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

Source §

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

Source §

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

Source §

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

Source §

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

Source §

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

Source §

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

Source §

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

Source §

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

Source §

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

Source §

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

Source §

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

Source §

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

Source §

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

Source §

impl<T, R> Morph<R> for T
where T: ?Sized,

Source §

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Morphs the value into a new one and returns it. Read more

Source §

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Morphs the value by shared reference and returns the result. Read more

Source §

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Morphs the value by exclusive reference and returns the result. Read more

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = !

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, !> ⓘ

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error> ⓘ

Performs the conversion.

Struct UiFrame Copy item path

Implementations§

impl UiFrame

pub const fn new() -> Self

pub const fn from_parts(phase: UiPhase, scope: UiScope) -> Self

pub const fn phase(&self) -> UiPhase

pub const fn scope(&self) -> UiScope

pub const fn with_phase(self, phase: UiPhase) -> Self

pub const fn with_scope(self, scope: UiScope) -> Self

pub const fn id(&self, key: UiKey) -> UiId

pub const fn enter(self, key: UiKey) -> Self

Trait Implementations§

impl Clone for UiFrame

fn clone(&self) -> UiFrame

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

impl Copy for UiFrame

impl Debug for UiFrame

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

impl Default for UiFrame

fn default() -> UiFrame

impl Eq for UiFrame

impl Hash for UiFrame

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

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

impl PartialEq for UiFrame

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

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

impl StructuralPartialEq for UiFrame

Auto Trait Implementations§

impl Freeze for UiFrame

impl RefUnwindSafe for UiFrame

impl Send for UiFrame

impl Sync for UiFrame

impl Unpin for UiFrame

impl UnsafeUnpin for UiFrame

impl UnwindSafe for UiFrame

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> AnyExt for Twhere T: Any + ?Sized,

fn type_id() -> TypeId

fn type_of(&self) -> TypeId

fn type_name(&self) -> &'static str ⓘ

fn type_is<T: 'static>(&self) -> bool

fn type_hash(&self) -> u64

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

fn as_any_ref(&self) -> &dyn Anywhere Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Anywhere Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>where Self: Sized,

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

const BYTE_SIZE: usize = _

fn byte_align(&self) -> usize

fn byte_size(&self) -> usize

fn ptr_size_ratio(&self) -> [usize; 2]

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Hook for T

fn hook<F>(self, f: F) -> Selfwhere F: FnOnce(&mut Self),

fn tap<F>(self, f: F) -> Selfwhere F: FnOnce(&Self),

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> MemExt for Twhere T: ?Sized,

const NEEDS_DROP: bool = _

fn mem_align_of<T>() -> usize

fn mem_align_of_val(&self) -> usize

fn mem_size_of<T>() -> usize

fn mem_size_of_val(&self) -> usize

fn mem_copy(&self) -> Selfwhere Self: Copy,

fn mem_needs_drop(&self) -> bool

Struct UiFrame

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

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> AnyExt for T
where T: Any + ?Sized,

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> MemExt for T
where T: ?Sized,

fn mem_copy(&self) -> Self
where Self: Copy,

fn mem_drop(self)
where Self: Sized,

fn mem_forget(self)
where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

fn mem_take(&mut self) -> Self
where Self: Default,

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

impl<T, R> Morph<R> for T
where T: ?Sized,

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,