[][src]Crate crossterm

Structs

AlternateScreen

With this type you will be able to switch to alternate screen and back to main screen. Check also the Screen type for swishing to alternate mode.

AsyncReader

This type allows you to read the input asynchronously which means that input events are gathered on the background and will be queued for you to read.

Crossterm

This type offers a easy way to use functionalities like cursor, terminal, color, input, styling.

ObjectStyle

Struct that contains the style properties that can be applied to an displayable object.

RawScreen

A wrapper for the raw terminal state. Which can be used to write to.

StyledObject

Contains both the style and the content wits can be styled.

SyncReader

This type allows you to read input synchronously, which means that reading call will be blocking ones.

Terminal

Allows you to preform actions on the terminal.

TerminalColor

Allows you to style the terminal.

TerminalCursor

Allows you to preform actions with the terminal cursor.

TerminalInput

Allows you to read user input.

Enums

Attribute

These are all the attributes which could be apply to font. There are few things to note

ClearType

Enum that specifies a way of clearing.

Color

Colors that are available for coloring the terminal font.

Colored

Could be used to color the foreground or background color.

ErrorKind

Wrapper for all errors who could occur in crossterm.

InputEvent

Enum to specify which input event has occurred.

KeyEvent

Enum with different key or key combinations.

MouseButton

Enum to define mouse buttons.

MouseEvent

Enum to specify which mouse event has occurred.

Traits

Colorize

Provides a set of methods to color any type implementing Display with attributes.

IntoRawMode

Types which can be converted into "raw mode".

Styler

Provides a set of methods to style any type implementing Display with attributes.

Functions

color

Get a TerminalColor implementation whereon color related actions can be performed.

cursor

Get a TerminalCursor instance whereon cursor related actions can be performed.

input

Get a TerminalInput instance whereon input related actions can be performed.

style

This could be used to style a type who is implementing Display with colors and attributes.

terminal

Get a Terminal instance whereon terminal related actions could performed.

Type Definitions

Result

The crossterm result type.