Struct yacll::Yogurt

pub struct Yogurt { /* private fields */ }

Yet Another Data Storage U Struct. Main struct for methods.

Unless a method specifies it flushes the buffer, calling the flush method will be required for the changes to take effect.

Implementations

impl Yogurt

Output to the terminal.

pub fn print(&mut self, displ: impl Display) -> Result<()>

Print a string to the cursor location.

pub fn mv(&mut self, point: impl Into<Point>) -> Result<()>

Move the cursor to the specified point.

pub fn mv_print(
    &mut self,
    point: impl Into<Point>,
    displ: impl Display
) -> Result<()>

Move the cursor to the specified point and print.

pub fn flush(&mut self) -> Result<()>

Flush the buffer.

pub fn draw_box(
    &mut self,
    up_corner: impl Into<Point>,
    down_corner: impl Into<Point>,
    chars: [char; 8]
) -> Result<()>

Draw a box with the provided characters.

You can use the constants BORDER or ROUND_BORDER instead of defining your own.

Example of defining custom border:

let my_super_cool_border =
['┌', '─', '┐',
 '│',      '│',
 '└', '─', '┘'];

An example can be found by running $ cargo run --example=border.

pub fn enter_alt(&mut self) -> Result<()>

Enter “alternate mode.” See also leave_alt.

In alternate mode, the following things are true:

• input will be avaliable imideately to the program (not line buffered)
• special keys will not be processed (^C won’t do anything!)
• newline will not be proccessed
• an “alternate screen” will be entered, which has no scroll area and any changes made to the screen will not be preserved when switching back to the main screen.

In effect, alternate mode just enters an alternate screen and enables terminal raw mode.

This function also flushes the buffer.

pub fn leave_alt(&mut self) -> Result<()>

Leave “alternate mode.” See also enter_alt.

This function also flushes the buffer.

pub fn clear(&mut self, cleartype: ClrT) -> Result<()>

Clear the screen.

impl Yogurt

Styling of text and cursor.

pub fn cursor_on(&mut self, cursor: CursorAttr) -> Result<()>

Turn on a cursor attribute.

pub fn cursor_off(&mut self, cursor: CursorAttr) -> Result<()>

Turn off a cursor attribute. Turning off a cursor shape resets it to Block.

pub fn style(&mut self, style: Style) -> Result<()>

Enable a style.

impl Yogurt

Functions for getting input from the user.

pub fn read_event(&mut self, dur: Duration) -> Result<Option<Event>>

Read an event. Will error if not in alt-mode. Duration is how long to wait for an event before returning.

pub fn block_event(&mut self) -> Result<Event>

Like read_event, except instead of exiting with None after dur has passed, it blocks the thread.

impl Yogurt

pub fn new() -> Self

Create a new yogurt.

Trait Implementations

impl Debug for Yogurt

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

Formats the value using the given formatter.

impl Default for Yogurt

fn default() -> Self

Returns the “default value” for a type.