Skip to main content

Frame

Struct Frame 

Source
pub struct Frame<'a, B>
where B: Backend + 'a,
{ /* private fields */ }
Expand description

Represents a consistent terminal interface for rendering.

Implementations§

Source§

impl<'a, B> Frame<'a, B>
where B: Backend,

Source

pub fn size(&self) -> Rect

Terminal size, guaranteed not to change when rendering.

Source

pub fn render_widget<W>(&mut self, widget: &mut W, area: Rect)
where W: Widget,

Render a Widget to the current buffer using Widget::render.

§Examples
let mut block = Block::default();
let area = Rect::new(0, 0, 5, 5);
let mut frame = terminal.get_frame();
frame.render_widget(&mut block, area);
Source

pub fn current_buffer_mut(&mut self) -> &mut Buffer

Source

pub fn set_cursor(&mut self, x: u16, y: u16)

After drawing this frame, make the cursor visible and put it at the specified (x, y) coordinates. If this method is not called, the cursor will be hidden.

Note that this will interfere with calls to Terminal::hide_cursor(), Terminal::show_cursor(), and Terminal::set_cursor(). Pick one of the APIs and stick with it.

Auto Trait Implementations§

§

impl<'a, B> Freeze for Frame<'a, B>

§

impl<'a, B> RefUnwindSafe for Frame<'a, B>
where B: RefUnwindSafe,

§

impl<'a, B> Send for Frame<'a, B>
where B: Send,

§

impl<'a, B> Sync for Frame<'a, B>
where B: Sync,

§

impl<'a, B> Unpin for Frame<'a, B>

§

impl<'a, B> UnsafeUnpin for Frame<'a, B>

§

impl<'a, B> !UnwindSafe for Frame<'a, B>

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more