Struct crossterm_winapi::ScreenBuffer

pub struct ScreenBuffer { /* private fields */ }

A wrapper around a screen buffer.

Implementations

impl ScreenBuffer

pub fn new(handle: Handle) -> Self

Create a wrapper around a screen buffer from its handle.

pub fn current() -> Result<ScreenBuffer>

Get the current console screen buffer

pub fn create() -> Result<ScreenBuffer>

Create new console screen buffer.

This wraps CreateConsoleScreenBuffer

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

Set this screen buffer to the current one.

This wraps SetConsoleActiveScreenBuffer.

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

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

This wraps GetConsoleScreenBufferInfo.

pub fn font_info(&self) -> Result<FontInfo>

Get the current font information like size and font index.

This wraps GetConsoleFontSize.

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

Set the console screen buffer size to the given size.

This wraps SetConsoleScreenBufferSize.

pub fn handle(&self) -> &Handle

Get the underlying raw HANDLE used by this type to execute with.

Trait Implementations

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.

impl Debug for ScreenBuffer

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

Formats the value using the given formatter.

impl From<Handle> for ScreenBuffer

fn from(handle: Handle) -> Self

Converts to this type from the input type.