Skip to main content

WindowMetrics

Struct WindowMetrics 

Source
pub struct WindowMetrics {
    pub size: Size,
    pub scale: f64,
    pub orientation: Orientation,
    pub insets: WindowInsets,
}
Expand description

The window’s shape, flat-re-exported from frust-core::app so app code (not just widget authors, see authoring::WindowMetrics) can recover it via use_context::<WindowMetrics>() inside Component::build — a component laying itself out around window size/scale/orientation reads this the same way it reads a Theme via use_context. Delivered as a plain value (not an RwSignal); see WindowMetrics’s own doc for the derived-Orientation and rebuild-cost notes. The window’s shape and platform-occlusion state, delivered to app code as a plain provide_context-carried value — logical size, device-pixel scale, a derived orientation, and the current WindowInsets.

§Plain value, not a signal

WindowMetrics is delivered exactly like Theme and WindowInsets already are: a shell calls provide_context with a freshly-built value on change, and app code recovers it with use_context::<WindowMetrics>() inside Component::build. It is not an RwSignal — only deep_link and back are true signals in frust-reactive; every other host-signal carrier (theme, insets, and now this) is a re-provided plain value.

§Alongside WindowInsets, not superseding it

WindowInsets already reaches Component::build on Android and iOS today (each shell’s push_insets calls provide_context(insets) independently of anything here — desktop has no such arm for either value yet). WindowMetrics is additive: a shell that starts providing it keeps providing the standalone WindowInsets context too, so an existing use_context::<WindowInsets>() call site never breaks. insets on this type is a copy of that same value for convenience (a widget laying itself out around window shape wants size/scale/orientation/insets together), not a replacement for the independent context.

§Orientation is derived, not platform-sourced

No platform callback in either mobile shell carries an orientation enum — Android’s nativeOnSurfaceChanged and iOS’s frust_resize each hand the shell only a (width, height, scale) triple. Orientation is therefore always computed from size via Orientation::from_size (portrait when height >= width, so an exact square reads as portrait); it never tracks a device orientation-lock setting or a platform rotation event directly.

§Context is not reactive

provide_context is a plain insert into the owner’s context map — it notifies nothing — and use_context inside Component::build (or the root build closure) creates no subscription, so re-providing a changed WindowMetrics does not itself mark anything dirty or wake a frame. A new value becomes visible only on the next rebuild, which the resize or inset change that produced it already drives; do not write a shell that assumes a provide_context write triggers one. A shell wiring this up (see docs/SHELLS_ARCHITECTURE.md) must still re-provide WindowMetrics only on an actual change (mirroring RenderRoot::set_insets’s PartialEq-guarded no-op) — the reason is cost at the FFI boundary (a lock write plus an allocation every frame), not a rebuild storm. Separately, there is no per-component rebuild skipping in this framework (a component always re-runs build on any rebuild it does take part in), which is affordable only because builds are cheap by construction.

Fields§

§size: Size

The window’s logical (density-independent) size.

§scale: f64

The device-pixel scale factor (logical → physical px multiplier).

§orientation: Orientation

The orientation derived from size — see the type’s doc for why this is computed, never platform-sourced.

§insets: WindowInsets

A copy of the window’s current insets — see the type’s doc for why this does not replace the standalone WindowInsets context.

Implementations§

Source§

impl WindowMetrics

Source

pub fn new(size: Size, scale: f64, insets: WindowInsets) -> WindowMetrics

Construct a WindowMetrics from its transported fields, deriving orientation from size rather than accepting it as an input — see the type’s doc for why orientation is never platform-sourced.

Trait Implementations§

Source§

impl Clone for WindowMetrics

Source§

fn clone(&self) -> WindowMetrics

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 WindowMetrics

Source§

impl Debug for WindowMetrics

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WindowMetrics

Source§

fn eq(&self, other: &WindowMetrics) -> 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 WindowMetrics

Auto Trait Implementations§

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> 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> ErasedDestructor for T
where T: 'static,

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<U> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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<U> 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<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more