Module ascii_forge::prelude

Re-exports

• pub use crossterm;
• pub use crate::math::*;
• pub use crate::renderer::buffer::*;
• pub use crate::renderer::cell::*;
• pub use crate::renderer::render::*;
• pub use crate::window::*;

Macros

• render
  A macro to simplify rendering lots of items at once. The Buffer can be anything that implements AsMut This render will return the location of which the last element finished rendering. Example

Structs

• Attributes
  a bitset for all possible attributes
• Colors
  Represents, optionally, a foreground and/or a background color.
• ContentStyle
  The style that can be put on content.
• DisableBlinking
  A command that disables blinking of the terminal cursor.
• DisableBracketedPaste
  A command that disables bracketed paste mode.
• DisableFocusChange
  A command that disables focus event emission.
• DisableMouseCapture
  A command that disables mouse event capturing.
• EnableBlinking
  A command that enables blinking of the terminal cursor.
• EnableBracketedPaste
  A command that enables bracketed paste mode.
• EnableFocusChange
  A command that enables focus event emission.
• EnableMouseCapture
  A command that enables mouse event capturing.
• Hide
  A command that hides the terminal cursor.
• KeyEvent
  Represents a key event.
• KeyEventState
  Represents extra state about the key event.
• KeyModifiers
  Represents key modifiers (shift, control, alt, etc.).
• KeyboardEnhancementFlags
  Represents special flags that tell compatible terminals to add extra information to keyboard events.
• MouseEvent
  Represents a mouse event.
• MoveDown
  A command that moves the terminal cursor a given number of rows down.
• MoveLeft
  A command that moves the terminal cursor a given number of columns to the left.
• MoveRight
  A command that moves the terminal cursor a given number of columns to the right.
• MoveTo
  A command that moves the terminal cursor to the given position (column, row).
• MoveToColumn
  A command that moves the terminal cursor to the given column on the current row.
• MoveToNextLine
  A command that moves the terminal cursor down the given number of lines, and moves it to the first column.
• MoveToPreviousLine
  A command that moves the terminal cursor up the given number of lines, and moves it to the first column.
• MoveToRow
  A command that moves the terminal cursor to the given row on the current column.
• MoveUp
  A command that moves the terminal cursor a given number of rows up.
• PopKeyboardEnhancementFlags
  A command that disables extra kinds of keyboard events.
• Print
  A command that prints the given displayable type.
• PrintStyledContent
  A command that prints styled content.
• PushKeyboardEnhancementFlags
  A command that enables the kitty keyboard protocol, which adds extra information to keyboard events and removes ambiguity for modifier keys.
• ResetColor
  A command that resets the colors back to default.
• RestorePosition
  A command that restores the saved terminal cursor position.
• SavePosition
  A command that saves the current terminal cursor position.
• SetAttribute
  A command that sets an attribute.
• SetAttributes
  A command that sets several attributes.
• SetBackgroundColor
  A command that sets the the background color.
• SetColors
  A command that optionally sets the foreground and/or background color.
• SetForegroundColor
  A command that sets the the foreground color.
• SetStyle
  A command that sets a style (colors and attributes).
• SetUnderlineColor
  A command that sets the the underline color.
• Show
  A command that shows the terminal cursor.
• StyledContent
  The style with the content to be styled.

Enums

• Attribute
  Represents an attribute.
• Color
  Represents a color.
• Colored
  Represents a foreground or background color.
• Event
  Represents an event.
• KeyCode
  Represents a key.
• KeyEventKind
  Represents a keyboard event kind.
• MediaKeyCode
  Represents a media key (as part of KeyCode::Media).
• ModifierKeyCode
  Represents a modifier key (as part of KeyCode::Modifier).
• MouseButton
  Represents a mouse button.
• MouseEventKind
  A mouse event kind.
• SetCursorStyle
  A command that sets the style of the cursor. It uses two types of escape codes, one to control blinking, and the other the shape.

Traits

• Stylize
  Provides a set of methods to set attributes and colors.

Functions

• available_color_count
  Returns available color count.
• force_color_output
  Forces colored output on or off globally, overriding NO_COLOR.
• poll
  Checks if there is an Event available.
• position
  Returns the cursor position (column, row).
• read
  Reads a single Event.
• style
  Creates a StyledContent.