Expand description
Shared ANSI escape sequence constants and small builders for VT Code.
See docs/reference/ansi-in-vtcode.md for the cross-crate integration map.
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 - APP_
CURSOR_ KEYS_ DISABLE - APP_
CURSOR_ KEYS_ ENABLE - Application Cursor Keys (DECCKM, mode 1)
- AUTO_
WRAP_ DISABLE - AUTO_
WRAP_ ENABLE - Auto-Wrap Mode (DECAWM, mode 7)
- BEL
- Bell character as a string slice
- BEL_
BYTE - Bell character as a raw byte (BEL = 0x07)
- BEL_
CHAR - Bell character as a
char - 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
- BRACKETED_
PASTE_ DISABLE - BRACKETED_
PASTE_ ENABLE - Bracketed Paste Mode (mode 2004)
- CHARSET_
DEFAULT - Select default (ISO 8859-1) character set
- CHARSET_
UTF8 - Select UTF-8 character set
- 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_
POSITION_ REQUEST - Device Status Report — request cursor position (DSR CPR)
- CURSOR_
RESTORE_ DEC - CURSOR_
RESTORE_ SCO - CURSOR_
SAVE_ DEC - CURSOR_
SAVE_ SCO - CURSOR_
SHOW - DCS
- Device Control String (DCS = ESC P)
- DELETE_
CHAR - Delete Ps Character(s) (default = 1) (DCH)
- DELETE_
LINE - Delete Ps Line(s) (default = 1) (DL)
- DEVICE_
ATTRIBUTES_ REQUEST - Primary Device Attributes (DA1) — request
- DEVICE_
STATUS_ REQUEST - Device Status Report — request terminal status
- DIM
- ERASE_
CHAR - Erase Ps Character(s) (default = 1) (ECH)
- ESC
- Escape character as a string slice
- ESC_
BYTE - Escape character as a raw byte (ESC = 0x1B = 27)
- ESC_
CHAR - Escape character as a
char - 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 - FOCUS_
EVENT_ DISABLE - FOCUS_
EVENT_ ENABLE - Focus Event Tracking (mode 1004)
- FULL_
RESET - Full Reset (RIS) — reset terminal to initial state
- HIDDEN
- INDEX
- Index — move cursor down one line, scroll if at bottom (IND)
- INSERT_
CHAR - Insert Ps Character(s) (default = 1) (ICH)
- INSERT_
LINE - Insert Ps Line(s) (default = 1) (IL)
- ITALIC
- KEYPAD_
APPLICATION - Application Keypad (DECPAM)
- KEYPAD_
NUMERIC - Normal Keypad (DECPNM)
- LINE_
WRAP_ DISABLE - LINE_
WRAP_ ENABLE - MOUSE_
ANY_ EVENT_ DISABLE - MOUSE_
ANY_ EVENT_ ENABLE - Any-event mouse tracking (mode 1003)
- MOUSE_
BUTTON_ EVENT_ DISABLE - MOUSE_
BUTTON_ EVENT_ ENABLE - Button-event mouse tracking (mode 1002)
- MOUSE_
NORMAL_ DISABLE - MOUSE_
NORMAL_ ENABLE - Normal mouse tracking — press and release (mode 1000)
- MOUSE_
SGR_ DISABLE - MOUSE_
SGR_ ENABLE - SGR extended mouse coordinates (mode 1006)
- MOUSE_
URXVT_ DISABLE - MOUSE_
URXVT_ ENABLE - URXVT extended mouse coordinates (mode 1015)
- MOUSE_
X10_ DISABLE - MOUSE_
X10_ ENABLE - X10 mouse reporting — button press only (mode 9)
- NEXT_
LINE - Next Line — move to first position of next line (NEL)
- ORIGIN_
MODE_ DISABLE - ORIGIN_
MODE_ ENABLE - Origin Mode (DECOM, mode 6)
- OSC
- Operating System Command (OSC = ESC])
- OSC_
BG_ COLOR_ PREFIX - Query/set background color — OSC 11
- OSC_
CLIPBOARD_ PREFIX - Clipboard access — OSC 52
- OSC_
CURSOR_ COLOR_ PREFIX - Query/set cursor color — OSC 12
- OSC_
FG_ COLOR_ PREFIX - Query/set foreground color — OSC 10
- OSC_
HYPERLINK_ PREFIX - Hyperlink — OSC 8
- OSC_
SET_ ICON_ AND_ TITLE_ PREFIX - Set icon name and title — OSC 0 ; Pt BEL
- OSC_
SET_ ICON_ PREFIX - Set icon name — OSC 1 ; Pt BEL
- OSC_
SET_ TITLE_ PREFIX - Set window title — OSC 2 ; Pt BEL
- REDRAW_
LINE_ PREFIX - Build a portable in-place redraw prefix (
CR+EL2). - RESET
- RESET_
BLINK - RESET_
BOLD_ DIM - RESET_
HIDDEN - RESET_
ITALIC - RESET_
REVERSE - RESET_
STRIKETHROUGH - RESET_
UNDERLINE - REVERSE
- REVERSE_
INDEX - Reverse Index — move cursor up one line, scroll if at top (RI)
- SCREEN_
RESTORE - SCREEN_
SAVE - SCROLL_
DOWN - Scroll down Ps lines (default = 1) (SD)
- SCROLL_
REGION_ RESET - Set Scrolling Region (DECSTBM) — CSI Ps ; Ps r
- SCROLL_
UP - Scroll up Ps lines (default = 1) (SU)
- ST
- String Terminator (ST = ESC )
- STRIKETHROUGH
- SYNC_
OUTPUT_ BEGIN - Synchronized Output (mode 2026) — batch rendering
- SYNC_
OUTPUT_ END - TAB_SET
- Horizontal Tab Set (HTS)
- UNDERLINE
Functions§
- bg_256
- bg_rgb
- bold
- colored
- combine_
styles - contains_
ansi - cursor_
down - cursor_
left - cursor_
right - cursor_
to - cursor_
up - delete_
lines - Delete Ps lines at cursor position
- dim
- display_
width - ends_
with_ ansi - fg_256
- fg_rgb
- format_
redraw_ line - Format a one-line in-place update payload.
- format_
styled_ into - hyperlink_
close - Build an OSC 8 hyperlink close sequence
- hyperlink_
open - Build an OSC 8 hyperlink open sequence
- insert_
lines - Insert Ps lines at cursor position
- 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.
- redraw_
line_ prefix - scroll_
down - Scroll down Ps lines
- scroll_
up - Scroll up Ps lines
- set_
scroll_ region - Set scrolling region (DECSTBM) — top and bottom rows (1-indexed)
- set_
window_ title - Build an OSC sequence to set the terminal window title
- starts_
with_ ansi - truncate_
to_ width - underline
- write_
styled