Expand description
ANSI escape sequence constants and utilities
Modules§
Enums§
- Hitl
Notify Mode - Notification preference (rich OSC vs bell-only)
- Terminal
Notify Kind - Terminal-specific notification capabilities
Constants§
- ALT_
BUFFER_ DISABLE - ALT_
BUFFER_ ENABLE - BEL
- Bell character (BEL = 0x07)
- BG_
BLACK - BG_BLUE
- BG_
BRIGHT_ BLACK - BG_
BRIGHT_ BLUE - BG_
BRIGHT_ CYAN - BG_
BRIGHT_ GREEN - BG_
BRIGHT_ MAGENTA - BG_
BRIGHT_ RED - BG_
BRIGHT_ WHITE - BG_
BRIGHT_ YELLOW - BG_CYAN
- BG_
DEFAULT - BG_
GREEN - BG_
MAGENTA - BG_RED
- BG_
WHITE - BG_
YELLOW - BLINK
- BOLD
- CLEAR_
LINE - CLEAR_
SAVED_ LINES - CLEAR_
SCREEN - CLEAR_
TO_ END_ OF_ LINE - CLEAR_
TO_ END_ OF_ SCREEN - CLEAR_
TO_ START_ OF_ LINE - CLEAR_
TO_ START_ OF_ SCREEN - CSI
- Control Sequence Introducer (CSI = ESC[)
- CURSOR_
HIDE - CURSOR_
HOME - CURSOR_
RESTORE_ DEC - CURSOR_
RESTORE_ SCO - CURSOR_
SAVE_ DEC - CURSOR_
SAVE_ SCO - CURSOR_
SHOW - DCS
- Device Control String (DCS = ESC P)
- DIM
- ESC
- Escape character (ESC = 0x1B = 27)
- FG_
BLACK - FG_BLUE
- FG_
BRIGHT_ BLACK - FG_
BRIGHT_ BLUE - FG_
BRIGHT_ CYAN - FG_
BRIGHT_ GREEN - FG_
BRIGHT_ MAGENTA - FG_
BRIGHT_ RED - FG_
BRIGHT_ WHITE - FG_
BRIGHT_ YELLOW - FG_CYAN
- FG_
DEFAULT - FG_
GREEN - FG_
MAGENTA - FG_RED
- FG_
WHITE - FG_
YELLOW - HIDDEN
- ITALIC
- LINE_
WRAP_ DISABLE - LINE_
WRAP_ ENABLE - OSC
- Operating System Command (OSC = ESC])
- RESET
- RESET_
BLINK - RESET_
BOLD_ DIM - RESET_
HIDDEN - RESET_
ITALIC - RESET_
REVERSE - RESET_
STRIKETHROUGH - RESET_
UNDERLINE - REVERSE
- SCREEN_
RESTORE - SCREEN_
SAVE - ST
- String Terminator (ST = ESC )
- STRIKETHROUGH
- UNDERLINE
Functions§
- bg_256
- bg_rgb
- bold
- colored
- combine_
styles - contains_
ansi - cursor_
down - cursor_
left - cursor_
right - cursor_
to - cursor_
up - dim
- display_
width - ends_
with_ ansi - fg_256
- fg_rgb
- format_
styled_ into - is_
bell_ enabled - Determine whether the bell should play, honoring an env override.
- italic
- notify_
attention - pad_
to_ width - play_
bell - Play the terminal bell when enabled.
- starts_
with_ ansi - truncate_
to_ width - underline
- write_
styled