Skip to main content

FrameState

Struct FrameState 

Source
pub struct FrameState { /* private fields */ }

Implementations§

Source§

impl FrameState

Source

pub fn new(rows: u16, cols: u16) -> Self

Source

pub fn from_parts( rows: u16, cols: u16, cursor_row: u16, cursor_col: u16, mode: u16, title: impl Into<String>, cells: Vec<u8>, ) -> Self

Source

pub fn rows(&self) -> u16

Source

pub fn cols(&self) -> u16

Source

pub fn cursor_row(&self) -> u16

Source

pub fn cursor_col(&self) -> u16

Source

pub fn mode(&self) -> u16

Source

pub fn title(&self) -> &str

Source

pub fn cells(&self) -> &[u8]

Source

pub fn cells_mut(&mut self) -> &mut [u8]

Source

pub fn overflow(&self) -> &BTreeMap<usize, String>

Source

pub fn overflow_mut(&mut self) -> &mut BTreeMap<usize, String>

Source

pub fn line_flags(&self) -> &[u8]

Source

pub fn line_flags_mut(&mut self) -> &mut Vec<u8>

Source

pub fn scrollback_lines(&self) -> u32

Source

pub fn set_scrollback_lines(&mut self, lines: u32)

Source

pub fn is_wrapped(&self, row: u16) -> bool

Source

pub fn set_wrapped(&mut self, row: u16, wrapped: bool)

Source

pub fn cell_content(&self, row: u16, col: u16) -> &str

Returns the text content of a cell, resolving overflow if needed.

Source

pub fn resize(&mut self, rows: u16, cols: u16)

Source

pub fn set_cursor(&mut self, row: u16, col: u16)

Source

pub fn set_mode(&mut self, mode: u16)

Source

pub fn set_title(&mut self, title: impl Into<String>) -> bool

Source

pub fn clear(&mut self, style: CellStyle)

Source

pub fn fill_rect(&mut self, rect: Rect, ch: char, style: CellStyle)

Source

pub fn write_text( &mut self, row: u16, col: u16, text: &str, style: CellStyle, ) -> u16

Source

pub fn write_wrapped_text( &mut self, rect: Rect, text: &str, style: CellStyle, ) -> usize

Source

pub fn write_scrolling_text<S: AsRef<str>>( &mut self, rect: Rect, lines: &[S], offset_from_bottom: usize, style: CellStyle, )

Source

pub fn get_text( &self, start_row: u16, start_col: u16, end_row: u16, end_col: u16, ) -> String

Source

pub fn get_all_text(&self) -> String

Source

pub fn get_ansi_text(&self) -> String

Source

pub fn get_cell(&self, row: u16, col: u16) -> Vec<u8>

Trait Implementations§

Source§

impl Clone for FrameState

Source§

fn clone(&self) -> FrameState

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 FrameState

Source§

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

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

impl Default for FrameState

Source§

fn default() -> FrameState

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

impl PartialEq for FrameState

Source§

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

Source§

impl StructuralPartialEq for FrameState

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