Skip to main content

Overlay

Struct Overlay 

Source
pub struct Overlay {
    pub content: Box<dyn Component>,
    pub position: OverlayPosition,
    pub constraints: OverlayConstraints,
}
Expand description

A floating component rendered on top of the main UI.

Fields§

§content: Box<dyn Component>

The component to render.

§position: OverlayPosition

How the overlay’s position is determined.

§constraints: OverlayConstraints

Sizing and visibility constraints.

Implementations§

Source§

impl Overlay

Source

pub fn compute_position( &self, term_w: u16, term_h: u16, content_w: u16, content_h: u16, ) -> Option<Rect>

Compute the screen rectangle for this overlay given the terminal size and the content’s natural dimensions.

Returns None if the overlay’s visibility predicate returns false.

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