Skip to main content

NodeSize

Struct NodeSize 

Source
pub struct NodeSize { /* private fields */ }
Expand description

A node whose measured size a reader follows.

The token is the name the screen gives the node, because a node id belongs to the Renderer and never crosses back as something the Host chose. Attach it with observe_size and read the size here. The Dioxus adapter hands one out from its use_node_size hook.

ⓘ
let panel = use_node_size();
rsx! {
    Card {
        observe_size: panel.token(),
        if panel.is_expanded() { Row { Left {} Right {} } } else { Left {} }
    }
}

A component that never calls this costs nothing: the modifier is the only thing that makes the Renderer measure, and the modifier comes from here.

Implementations§

Source§

impl NodeSize

Source

pub fn of(token: u32) -> Self

The node token names, with whatever it last measured.

Source

pub const fn token(&self) -> i64

The value to hand to observe_size.

Source

pub fn is_compact(&self) -> bool

Phone-shaped: narrower than 600dp.

Source

pub fn is_medium(&self) -> bool

Tablet-shaped.

Source

pub fn is_expanded(&self) -> bool

Desktop-shaped.

Source

pub const fn measured(&self) -> WindowSize

The measurement itself, zero until the Renderer has reported one.

Trait Implementations§

Source§

impl Clone for NodeSize

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 NodeSize

Source§

impl Debug for NodeSize

Source§

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

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

impl PartialEq for NodeSize

Source§

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

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.