Struct Frame

Source

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

Expand description

A sampled frame with Kit-native element builders and portable status getters.

Implementations§

Source §

impl Frame

Source

pub fn at(target: Target) -> Self

Creates a static Kit-ready frame, for custom mappings and portable sampling.

Source

pub fn apply<E: Styled>(self, element: E) -> E

Applies opacity, relative position, and declared dimensions/radius. Dimensions perform real layout. This sets relative position, left, and top; use an outer reservation when absolute placement is required.

Source

pub fn render<E: IntoElement>(self, build: impl FnOnce(Self) -> E) -> AnyElement

Keeps exiting elements rendered until absent. The owner must guard input and restore focus before removing a focused outgoing element.

Methods from Deref<Target = Frame>§

Source

pub fn just_completed(self) -> bool

Completion edge. Read once per view render to dispatch an owner-level event.

Source

pub fn target(self) -> Target

Current presentation values, rather than the declaration’s destination.

Source

pub fn velocity(self) -> [f64; 3]

Current x, y, and opacity velocities per second, before drawing clamps.

Source

pub fn layout_velocity(self) -> [Option<f64>; 3]

Width, height, and radius velocities in logical pixels per second. Undeclared channels return None; velocities are before drawing clamps.

Source

pub fn presence(self) -> Presence

Current lifecycle phase.

Source

pub fn is_animating(self) -> bool

Whether another animation frame is needed.

Source

pub fn is_mounted(self) -> bool

Whether the element must remain in the rendered tree, including its exit.

Source

pub fn is_present(self) -> bool

Whether the model requests presence. Disable exit-time input using this.

Trait Implementations§

Source §

impl Clone for Frame

Source §

fn clone(&self) -> Self

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 Frame

Source §

impl Debug for Frame

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Deref for Frame

Source §

type Target = Frame

The resulting type after dereferencing.

Source §

fn deref(&self) -> &Self::Target

Dereferences the value.

Source §

impl From<Frame> for Frame

Source §

fn from(frame: Frame) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl UnwindSafe for Frame

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> 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source §

impl<T> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> Downcast<T> for T

Source §

fn downcast(&self) -> &T

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §

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

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §