Struct crossterm_winapi::ScreenBuffer

pub struct ScreenBuffer { /* fields omitted */ }

Methods

impl ScreenBuffer

pub fn new(handle: Handle) -> Self

pub fn current() -> Result<ScreenBuffer>

Create an instance of ScreenBuffer where the HANDLE, used for the functions this type wraps, is the current output handle.

pub fn create() -> ScreenBuffer

Create new console screen buffer.

Wraps the underlying function call: CreateConsoleScreenBuffer link: [https://docs.microsoft.com/en-us/windows/console/createconsolescreenbuffer]

pub fn show(&self) -> Result<()>

This will make this ScreenBuffer the active one.

Wraps the underlying function call: SetConsoleActiveScreenBuffer link: [https://docs.microsoft.com/en-us/windows/console/setconsoleactivescreenbuffer]

pub fn info(&self) -> Result<ScreenBufferInfo>

Get the screen buffer information like terminal size, cursor position, buffer size.

Wraps the underlying function call: GetConsoleScreenBufferInfo link: [https://docs.microsoft.com/en-us/windows/console/getconsolescreenbufferinfo]

pub fn set_size(&self, x: i16, y: i16) -> Result<()>

Set the console screen buffer size to the given size.

Wraps the underlying function call: SetConsoleScreenBufferSize link: [https://docs.microsoft.com/en-us/windows/console/setconsolescreenbuffersize]

pub fn handle(&self) -> &Handle

Get the underlining raw HANDLE used by this type to execute whit.

Trait Implementations

impl From<Handle> for ScreenBuffer

fn from(handle: Handle) -> Self

Performs the conversion.

impl Clone for ScreenBuffer

fn clone(&self) -> ScreenBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.