Skip to main content

Visibility

Struct Visibility 

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

Breakpoint-aware visibility rule.

Encodes which breakpoints a widget should be visible at. Use with filter_rects to reclaim space from hidden widgets during layout.

Implementations§

Source§

impl Visibility

Source

pub const ALWAYS: Self

Visible at all breakpoints.

Source

pub const NEVER: Self

Hidden at all breakpoints.

Source§

impl Visibility

Source

pub const fn visible_above(bp: Breakpoint) -> Self

Visible at the given breakpoint and all larger ones.

Example: visible_above(Md) → visible at Md, Lg, Xl.

Source

pub const fn visible_below(bp: Breakpoint) -> Self

Visible at the given breakpoint and all smaller ones.

Example: visible_below(Md) → visible at Xs, Sm, Md.

Source

pub const fn only(bp: Breakpoint) -> Self

Visible at exactly one breakpoint.

Source

pub fn at(breakpoints: &[Breakpoint]) -> Self

Visible at the specified breakpoints.

Source

pub const fn hidden_below(bp: Breakpoint) -> Self

Hidden at the given breakpoint and all smaller ones (visible above).

Example: hidden_below(Md) → hidden at Xs, Sm; visible at Md, Lg, Xl.

Source

pub const fn hidden_above(bp: Breakpoint) -> Self

Hidden at the given breakpoint and all larger ones (visible below).

Example: hidden_above(Md) → visible at Xs, Sm; hidden at Md, Lg, Xl.

Source

pub const fn from_mask(mask: u8) -> Self

Create from a raw bitmask (bits 0–4 correspond to Xs–Xl).

Source§

impl Visibility

Source

pub const fn is_visible(self, bp: Breakpoint) -> bool

Whether the widget is visible at the given breakpoint.

Source

pub const fn is_hidden(self, bp: Breakpoint) -> bool

Whether the widget is hidden at the given breakpoint.

Source

pub const fn is_always(self) -> bool

Whether the widget is always visible (at every breakpoint).

Source

pub const fn is_never(self) -> bool

Whether the widget is never visible (hidden at every breakpoint).

Source

pub const fn mask(self) -> u8

The raw bitmask.

Source

pub const fn visible_count(self) -> u32

Count of breakpoints where this is visible.

Source

pub fn visible_breakpoints(self) -> impl Iterator<Item = Breakpoint>

Iterator over breakpoints where visible.

Source§

impl Visibility

Source

pub fn filter_rects<'a>( visibilities: &'a [Visibility], rects: &'a [Rect], bp: Breakpoint, ) -> Vec<(usize, Rect)>

Filter a list of rects, keeping only those whose visibility allows the given breakpoint.

Returns (index, rect) pairs for visible items. The index is the original position in the input, useful for mapping back to widget state.

This achieves space reclamation: hidden widgets don’t get any layout area.

Source

pub fn count_visible(visibilities: &[Visibility], bp: Breakpoint) -> usize

Count how many items are visible at a given breakpoint.

Trait Implementations§

Source§

impl Clone for Visibility

Source§

fn clone(&self) -> Visibility

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Visibility

Source§

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

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

impl Default for Visibility

Source§

fn default() -> Self

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

impl Display for Visibility

Source§

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

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

impl PartialEq for Visibility

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Visibility

Source§

impl Eq for Visibility

Source§

impl StructuralPartialEq for Visibility

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.