etch/terminal

This module provides terminal associated functions like entering raw mode, alternative screen, setting title etc.

Types

ClearType

Used in clear function.

pub type ClearType {
  All
  Purge
  FromCursorDown
  FromCursorUp
  CurrentLine
  UntilNewLine
}

Constructors

```
All
```
Clears the whole screen.
```
Purge
```
Clears the whole screen and the history.
```
FromCursorDown
```
Clears cells from the cursor downwards.
```
FromCursorUp
```
Clears cells from the cursor upwards.
```
CurrentLine
```
Clears cells at the current cursor row.
```
UntilNewLine
```
Clears cells from the cursor positon until the end.

TerminalError

</>

Event error.

pub type TerminalError {
  FailedToEnterRawMode
  FailedToExitRawMode
  CouldNotGetWindowSize
}

Constructors

```
FailedToEnterRawMode
```
```
FailedToExitRawMode
```
```
CouldNotGetWindowSize
```

Values

clear

</>

pub fn clear(t: ClearType) -> String

Clears the terminal. See ClearType. It is prefered not to use this directly. See Clear.

disable_line_wrap

</>

pub fn disable_line_wrap() -> String

Disable line wrap. It is prefered not to use this directly. See DisableLineWrap.

enable_line_wrap

</>

pub fn enable_line_wrap() -> String

Enable line wrap. It is prefered not to use this directly. See EnableLineWrap.

enter_alternative

</>

pub fn enter_alternative() -> String

Enter alternative screen. It is prefered not to use this directly. See EnterAlternative.

enter_raw

</>

pub fn enter_raw() -> Result(Nil, TerminalError)

Enters raw mode.

Raw mode is a mode where the terminal does not process input, but instead passes it directly to the application. This means that:

Input is not echoed to the screen
Input is not line-buffered (characters are available immediately)
Some special characters are not processed by the terminal

This is necessary for terminal UI applications that need to handle keyboard input and mouse events directly. Exits raw mode.

Raw mode is a mode where the terminal does not process input, but instead passes it directly to the application. This means that:

Input is not echoed to the screen
Input is not line-buffered (characters are available immediately)
Some special characters are not processed by the terminal

Warning: This function is currently broken when used with the event server. If event.init_event_server was called, exiting raw mode will break input handling. The event server relies on raw mode being active to properly read events.

exit_raw

</>

pub fn exit_raw() -> Result(Nil, TerminalError)

is_raw_mode

</>

pub fn is_raw_mode() -> Bool

leave_alternative

</>

pub fn leave_alternative() -> String

Leave alternative screen. It is prefered not to use this directly. See LeaveAlternative.

scroll_down

</>

pub fn scroll_down(n: Int) -> String

Scroll N rows down. It is prefered not to use this directly. See ScrollDown.

scroll_up

</>

pub fn scroll_up(n: Int) -> String

Scroll N rows up. It is prefered not to use this directly. See ScrollUp.

set_size

</>

pub fn set_size(x: Int, y: Int) -> String

Set window size. It does not work on most modern terminals due to security issues. It is prefered not to use this directly. See SetSize.

set_title

</>

pub fn set_title(s: String) -> String

Sets terminal title. It is prefered not to use this directly. See SetTitle.

window_size

</>

pub fn window_size() -> Result(#(Int, Int), TerminalError)

Returns current window size.