Skip to main content

Screen

Struct Screen 

Source
pub struct Screen {
    pub renderable: DynRenderable,
    pub style: Option<Style>,
    pub application_mode: bool,
}
Expand description

A renderable that fills the entire terminal screen, cropping or padding its content to exactly fit the screen dimensions.

Equivalent to Rich’s Screen class.

Fields§

§renderable: DynRenderable

The child renderable.

§style: Option<Style>

Optional style applied as a background / padding style.

§application_mode: bool

If true, use \n\r line endings (application mode for raw terminals).

Implementations§

Source§

impl Screen

Source

pub fn new(renderable: impl Renderable + Send + Sync + 'static) -> Self

Create a new Screen wrapping the given renderable.

Source

pub fn style(self, style: Style) -> Self

Builder: set the optional background / padding style.

Source

pub fn application_mode(self, mode: bool) -> Self

Builder: set application mode (uses \n\r instead of \n).

Source

pub fn update<T>(&mut self, update: T)
where T: Into<ScreenUpdate>,

Update the content renderable.

Trait Implementations§

Source§

impl Debug for Screen

Source§

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

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

impl Renderable for Screen

Source§

fn render(&self, options: &ConsoleOptions) -> RenderResult

Render this object into a RenderResult using the provided options. Read more
Source§

fn measure(&self, _options: &ConsoleOptions) -> Option<Measurement>

Optional width-measurement hook (equivalent to __rich_measure__). Override to provide min/max width constraints for layout.

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.