Skip to main content

SafeAreaInsets

Struct SafeAreaInsets 

Source
#[repr(C)]
pub struct SafeAreaInsets { pub top: OptionPixelValue, pub bottom: OptionPixelValue, pub left: OptionPixelValue, pub right: OptionPixelValue, pub keyboard: OptionPixelValue, }
Expand description

Safe area insets for devices with notches, rounded corners, or sensor housings.

On devices like iPhones with notches or Dynamic Island, the safe area indicates regions where content should not be placed to avoid being obscured by hardware features.

Fields§

§top: OptionPixelValue

Inset from the top edge (notch, camera housing, etc.)

§bottom: OptionPixelValue

Inset from the bottom edge (home indicator on iPhone)

§left: OptionPixelValue

Inset from the left edge (rounded corners)

§right: OptionPixelValue

Inset from the right edge (rounded corners)

§keyboard: OptionPixelValue

How much of the window the on-screen keyboard currently covers, from the bottom edge. APPENDED for ABI stability.

Deliberately NOT folded into bottom. The two have different lifetimes and different meanings: bottom is the home indicator and is fixed for the life of the window, while this appears and disappears and is animated by the OS. An app that adds them together gets the right answer; one that needs to know why its content shrank cannot recover that from a single number.

None on desktop and whenever no keyboard is up. Android reports it as WindowInsets.Type.ime(), iOS as the intersection of UIKeyboardFrameEndUserInfoKey with the view.

Trait Implementations§

Source§

impl Clone for SafeAreaInsets

Source§

fn clone(&self) -> SafeAreaInsets

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 SafeAreaInsets

Source§

impl Debug for SafeAreaInsets

Source§

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

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

impl Default for SafeAreaInsets

Source§

fn default() -> SafeAreaInsets

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

impl Eq for SafeAreaInsets

Source§

impl PartialEq for SafeAreaInsets

Source§

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

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.