xnano_core.rust

xnano_core.rust ¶

xnano_core.rust

Modules:

engine –

xnano_core.rust.engine
native –

Classes:

Alignment –

Text alignment.
Axis –
Bar –

Single bar in a bar chart.
BarChart –

Bar chart widget.
BarGroup –

Group of bars in a bar chart.
Block –

Decorative block with optional borders and title.
BorderSet –

Border glyph set for :class:Block.
BorderType –

Border rendering style.
Borders –

Border flag set.
Buffer –

Off-screen render buffer.
BufferCell –

Single buffer cell.
BufferMutView –

Mutable view onto a live buffer, valid only for the duration of a drawable callback.
Canvas –
Cell –

Table cell.
CellFilter –

Cell selection filter for effects.
Chart –
Clear –

Widget that clears the render area.
ClearType –

Terminal clear mode.
Color –

Terminal color.
ColorSpace –

Color interpolation space.
CompletedFrame –

Snapshot of terminal state after a successful draw.
ConsoleAttribute –

Console text attribute.
ConsoleColor –

Console foreground/background color.
Constraint –

Layout size constraint.
CoreEvent –

Unified event delivered by the session event loop.
CoreTerminalEventKind –

Discriminator for :class:CoreEvent.
CoreTickEvent –

Synthetic clock tick emitted by :class:CoreSession.
CursorStyle –

Terminal cursor shape.
Dataset –
Direction –

Layout direction.
Duration –

Effect duration.
Effect –

Terminal visual effect.
EffectManager –
EffectTimer –

Effect timing and interpolation state.
EvolveSymbolSet –

Symbol progression set for evolve effects.
ExpandDirection –

Bidirectional expand direction.
Flex –

Flex distribution mode for layout constraints.
Frame –

Frame context valid only for the duration of a Terminal.draw callback.
Gauge –

Progress gauge widget.
GraphType –
HighlightSpacing –

Highlight spacing for list/table widgets.
Interpolation –

Effect interpolation curve.
KeyCode –

Key code category.
KeyEvent –

Keyboard event data.
KeyEventKind –

Key event phase.
KeyEventState –

Extra keyboard event state flags.
KeyModifiers –

Keyboard modifier flags.
KeyboardEnhancementFlags –

Keyboard enhancement protocol flags.
Layout –

Constraint-based layout splitter.
LayoutSpacing –

Layout child spacing mode.
LegendPosition –
Line –

A line of styled spans.
LineGauge –

Horizontal line gauge widget.
ListDirection –

List rendering direction.
ListItem –

Single list entry.
ListState –
Margin –
Marker –
Modifier –

Text style modifier flags.
Motion –

Effect motion direction.
MouseButton –

Mouse button identifier.
MouseEvent –

Mouse event data.
MouseEventKind –

Mouse event kind.
Offset –
Padding –

Block inner padding.
Paragraph –

Multi-line text widget.
Position –
RadialPattern –

Radial spatial pattern for effects.
RatList –

Selectable list widget.
RatTable –

Table widget.
Rect –
RefRect –

Mutable reference to a rectangle area.
RepeatMode –

Effect repeat mode.
Row –

Table row.
ScrollDirection –

Scrollbar scroll direction.
Scrollbar –

Scrollbar widget.
ScrollbarOrientation –

Scrollbar orientation.
ScrollbarState –
Size –
Span –

Styled text span.
Sparkline –

Sparkline chart widget.
Style –

Combined foreground, background, and modifier style.
TableState –
Tabs –

Tab bar widget.
Terminal –

Ratatui terminal handle.
Text –

Multi-line styled text.
TitlePosition –

Block title position.
Wrap –

Functions:

begin_synchronized_update –

Begin a synchronized terminal update.
clear_terminal –

Clear the terminal using the given clear type.
coalesce –

Coalesce effect. See :func:tachyonfx::fx::coalesce.
coalesce_from –

Coalesce from a style. See :func:tachyonfx::fx::coalesce_from.
color_from_hex –

Parse a hex color string (#RGB or #RRGGBB).
color_from_hsl –

Create a color from HSL components.
color_lerp –

Linearly interpolate between two colors.
color_to_hsl –

Convert a color to HSL components (hue in degrees, saturation, lightness).
color_to_srgb –

Convert a color to normalized sRGB components (0.0–1.0).
consume_tick_effect –

Consume one tick without visual change. See :func:tachyonfx::fx::consume_tick.
darken –

Darken colors. See :func:tachyonfx::fx::darken.
darken_bg –

Darken background. Convenience wrapper around :func:darken.
darken_fg –

Darken foreground. See :func:tachyonfx::fx::darken_fg.
delay_effect –

Delay before starting an effect. See :func:tachyonfx::fx::delay.
disable_bracketed_paste –

Disable bracketed paste mode.
disable_cursor_blinking –

Disable cursor blinking.
disable_focus_change –

Disable focus change events.
disable_line_wrap –

Disable terminal line wrapping.
disable_mouse_capture –

Disable mouse event capture.
disable_raw_mode –

Disable terminal raw mode.
dissolve –

Dissolve effect. See :func:tachyonfx::fx::dissolve.
dissolve_to –

Dissolve to a style. See :func:tachyonfx::fx::dissolve_to.
enable_bracketed_paste –

Enable bracketed paste mode.
enable_cursor_blinking –

Enable cursor blinking.
enable_focus_change –

Enable focus change events.
enable_line_wrap –

Enable terminal line wrapping.
enable_mouse_capture –

Enable mouse event capture.
enable_raw_mode –

Enable terminal raw mode.
end_synchronized_update –

End a synchronized terminal update.
enter_alternate_screen –

Switch to the alternate screen buffer.
evolve_effect –

Evolve cell symbols. See :func:tachyonfx::fx::evolve.
evolve_from_effect –

Evolve symbols from source style. See :func:tachyonfx::fx::evolve_from.
evolve_into_effect –

Evolve symbols into target style. See :func:tachyonfx::fx::evolve_into.
expand_effect –

Bidirectional expand using block characters. See :func:tachyonfx::fx::expand.
explode_effect –

Explode cells outward. See :func:tachyonfx::fx::explode.
fade_from –

Fade from foreground and background colors. See :func:tachyonfx::fx::fade_from.
fade_from_fg –

Fade foreground from a color. See :func:tachyonfx::fx::fade_from_fg.
fade_to –

Fade to foreground and background colors. See :func:tachyonfx::fx::fade_to.
fade_to_fg –

Fade foreground to a color. See :func:tachyonfx::fx::fade_to_fg.
flush_stdout_buffer –

Flush queued stdout commands.
freeze_at_effect –

Freeze an effect at a given alpha. See :func:tachyonfx::fx::freeze_at.
get_cursor_position –

Query the current cursor position.
glitch_effect –

Glitch effect with randomized cell mutations. See :class:tachyonfx::fx::Glitch.
hide_cursor –

Hide the terminal cursor.
hsl_shift –

Shift HSL values. See :func:tachyonfx::fx::hsl_shift.
hsl_shift_bg –

Shift background HSL. Convenience wrapper around :func:hsl_shift.
hsl_shift_fg –

Shift foreground HSL. See :func:tachyonfx::fx::hsl_shift_fg.
interpolate_colors –

Interpolate between two colors in RGB or HSL space.
is_raw_mode_enabled –

Return whether raw mode is enabled.
leave_alternate_screen –

Leave the alternate screen buffer.
lighten –

Lighten colors. See :func:tachyonfx::fx::lighten.
lighten_bg –

Lighten background. Convenience wrapper around :func:lighten.
lighten_fg –

Lighten foreground. See :func:tachyonfx::fx::lighten_fg.
move_cursor_down –

Move the cursor down by count cells.
move_cursor_left –

Move the cursor left by count cells.
move_cursor_right –

Move the cursor right by count cells.
move_cursor_to –

Move the cursor to (x, y).
move_cursor_to_column –

Move the cursor to column x on the current row.
move_cursor_to_next_line –

Move the cursor to the next line.
move_cursor_to_previous_line –

Move the cursor to the previous line.
move_cursor_to_row –

Move the cursor to row y on the current column.
move_cursor_up –

Move the cursor up by count cells.
never_complete_effect –

Prevent effect from completing. See :func:tachyonfx::fx::never_complete.
paint –

Paint cells to colors. See :func:tachyonfx::fx::paint.
paint_bg –

Paint background color. See :func:tachyonfx::fx::paint_bg.
paint_fg –

Paint foreground color. See :func:tachyonfx::fx::paint_fg.
parallel_effects –

Run effects in parallel. See :func:tachyonfx::fx::parallel.
ping_pong_effect –

Ping-pong an effect. See :func:tachyonfx::fx::ping_pong.
poll_event –

Poll for a terminal event with a timeout in milliseconds.
pop_keyboard_enhancement_flags –

Pop keyboard enhancement flags.
print_styled_content –

Print styled text to stdout.
print_text –

Print plain text to stdout.
prolong_end_effect –

Hold the end state. See :func:tachyonfx::fx::prolong_end.
prolong_start_effect –

Hold the start state. See :func:tachyonfx::fx::prolong_start.
push_keyboard_enhancement_flags –

Push keyboard enhancement flags.
read_event –

Block until a terminal event is available.
remap_alpha_effect –

Remap effect alpha range. See :func:tachyonfx::fx::remap_alpha.
render_stateful_widget –

Render any supported stateful widget into a buffer region.
render_widget –

Render any supported widget into a buffer region.
repeat_effect –

Repeat an effect. See :func:tachyonfx::fx::repeat.
repeating_effect –

Repeat an effect forever. See :func:tachyonfx::fx::repeating.
reset_color –

Reset console colors to default.
resize_area_effect –

Resize effect area over time. See :func:tachyonfx::fx::resize_area.
restore_cursor_position –

Restore the saved cursor position.
restore_terminal –

Restore the terminal to its pre-ratatui state.
run_once_effect –

Run effect only once. See :func:tachyonfx::fx::run_once.
saturate –

Adjust saturation. See :func:tachyonfx::fx::saturate.
saturate_bg –

Adjust background saturation. Convenience wrapper around :func:saturate.
saturate_fg –

Adjust foreground saturation. See :func:tachyonfx::fx::saturate_fg.
save_cursor_position –

Save the current cursor position.
scroll_down –

Scroll the terminal buffer down.
scroll_up –

Scroll the terminal buffer up.
sequence_effects –

Run effects in sequence. See :func:tachyonfx::fx::sequence.
set_attribute –

Set a console text attribute.
set_background_color –

Set the console background color.
set_cursor_style –

Set the terminal cursor style.
set_foreground_color –

Set the console foreground color.
set_terminal_title –

Set the terminal window title.
show_cursor –

Show the terminal cursor.
sleep_effect –

No-op delay effect. See :func:tachyonfx::fx::sleep.
slide_in –

Slide effect in. See :func:tachyonfx::fx::slide_in.
slide_out –

Slide effect out. See :func:tachyonfx::fx::slide_out.
stretch_effect –

Unidirectional stretch/shrink using block characters. See :func:tachyonfx::fx::stretch.
styled_span –

Create a styled span from a string and style shorthand methods.
supports_keyboard_enhancement –

Return whether the terminal supports keyboard enhancement.
sweep_in –

Sweep effect in. See :func:tachyonfx::fx::sweep_in.
sweep_out –

Sweep effect out. See :func:tachyonfx::fx::sweep_out.
tailwind_color –

Look up a Tailwind CSS palette color.
terminal_size –

Return the terminal size in columns and rows.
terminal_window_size –

Return the terminal window size in columns and rows.
timed_never_complete_effect –

Never complete for a bounded duration. See :func:tachyonfx::fx::timed_never_complete.
translate_effect –

Translate an effect's area. See :func:tachyonfx::fx::translate.
with_duration_effect –

Override effect duration. See :func:tachyonfx::fx::with_duration.

Alignment ¶

Text alignment.

Maps to :class:ratatui::layout::Alignment. See https://docs.rs/ratatui/0.29.0/ratatui/layout/enum.Alignment.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Axis ¶

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Bar ¶

Single bar in a bar chart.

Maps to :class:ratatui::widgets::Bar. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Bar.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

BarChart ¶

Bar chart widget.

Maps to :class:ratatui::widgets::BarChart. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.BarChart.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

BarGroup ¶

Group of bars in a bar chart.

Maps to :class:ratatui::widgets::BarGroup. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.BarGroup.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Block ¶

Decorative block with optional borders and title.

Maps to :class:ratatui::widgets::Block. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Block.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

BorderSet ¶

Border glyph set for :class:Block.

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

BorderType ¶

Border rendering style.

Maps to :class:ratatui::widgets::BorderType. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/enum.BorderType.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Borders ¶

Border flag set.

Maps to :class:ratatui::widgets::Borders. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Borders.html

Methods:

__or__ –

Return self|value.
__repr__ –

Return repr(self).
__ror__ –

Return value|self.

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

or `method descriptor` ¶

__or__(value) -> Borders

Return self|value.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

ror `method descriptor` ¶

__ror__(value)

Return value|self.

Buffer ¶

Off-screen render buffer.

Maps to :class:ratatui::buffer::Buffer. See https://docs.rs/ratatui/0.29.0/ratatui/buffer/struct.Buffer.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

BufferCell ¶

Single buffer cell.

Maps to :class:ratatui::buffer::Cell. See https://docs.rs/ratatui/0.29.0/ratatui/buffer/struct.Cell.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

BufferMutView ¶

Mutable view onto a live buffer, valid only for the duration of a drawable callback.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = "Mutable view onto a live buffer, valid only for the duration of a drawable callback."

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Canvas ¶

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Cell ¶

Table cell.

Maps to :class:ratatui::widgets::Cell. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Cell.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

CellFilter ¶

Cell selection filter for effects.

Not thread-safe (unsendable).

Maps to :class:tachyonfx::CellFilter. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/struct.CellFilter.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Chart ¶

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Clear ¶

Widget that clears the render area.

Maps to :class:ratatui::widgets::Clear. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Clear.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

ClearType ¶

Terminal clear mode.

Maps to :class:crossterm::terminal::ClearType.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Color ¶

Terminal color.

Maps to :class:ratatui::style::Color. See https://docs.rs/ratatui/0.29.0/ratatui/style/enum.Color.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__hash__ –

Return hash(self).
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value) -> bool

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

hash `method descriptor` ¶

__hash__() -> int

Return hash(self).

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

ColorSpace ¶

Color interpolation space.

Maps to :class:tachyonfx::ColorSpace. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/enum.ColorSpace.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

CompletedFrame ¶

Snapshot of terminal state after a successful draw.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = (
    "Snapshot of terminal state after a successful draw."
)

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

ConsoleAttribute ¶

Console text attribute.

Maps to :class:crossterm::style::Attribute.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

ConsoleColor ¶

Console foreground/background color.

Maps to :class:crossterm::style::Color.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Constraint ¶

Layout size constraint.

Maps to :class:ratatui::layout::Constraint. See https://docs.rs/ratatui/0.29.0/ratatui/layout/enum.Constraint.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

CoreEvent ¶

Unified event delivered by the session event loop.

Exactly one of key, paste, mouse, or tick is populated for each kind; on Resize events both width and height are set; FocusGained / FocusLost carry no payload. Consumers should dispatch on kind and read only the associated payload field.

Attributes:

kind (CoreTerminalEventKind) –

Which of the seven event kinds this event represents.
key (Optional[KeyEvent]) –

Populated when kind == CoreTerminalEventKind.Key.
width (Optional[int]) –

Populated when kind == CoreTerminalEventKind.Resize.
height (Optional[int]) –

Populated when kind == CoreTerminalEventKind.Resize.
paste (Optional[str]) –

Populated when kind == CoreTerminalEventKind.Paste.
mouse (Optional[MouseEvent]) –

Populated when kind == CoreTerminalEventKind.Mouse.
tick (Optional[CoreTickEvent]) –

Populated when kind == CoreTerminalEventKind.Tick.

Methods:

kind_str –

Return the event kind as a lowercase string.

kind_str ¶

kind_str() -> Literal[
    "key",
    "resize",
    "paste",
    "mouse",
    "focus_gained",
    "focus_lost",
    "tick",
]

Return the event kind as a lowercase string.

CoreTerminalEventKind ¶

Discriminator for :class:CoreEvent.

Attributes:

Key (CoreTerminalEventKind) –

The event carries a keyboard :class:~xnano_core.rust.native.KeyEvent.
Resize (CoreTerminalEventKind) –

The terminal reports a new size. width and height on the event are populated.
Paste (CoreTerminalEventKind) –

The terminal reports bracketed-paste content. paste on the event is populated.
Mouse (CoreTerminalEventKind) –

The event carries a :class:~xnano_core.rust.native.MouseEvent.
FocusGained (CoreTerminalEventKind) –

The terminal window received focus. No payload.
FocusLost (CoreTerminalEventKind) –

The terminal window lost focus. No payload.
Tick (CoreTerminalEventKind) –

The event was synthesized by the session tick clock. tick on the event is populated with a :class:CoreTickEvent.

CoreTickEvent ¶

Synthetic clock tick emitted by :class:CoreSession.

Ticks are only produced when the session was constructed with tick_rate_ms set. They are opt-in: a session with no configured tick interval never yields Tick events, so downstream consumers can rely on poll_event blocking purely on real input.

Attributes:

elapsed_ms (int) –

Milliseconds elapsed since the previous tick was emitted (or since :meth:CoreSession.init for the first tick).

CursorStyle ¶

Terminal cursor shape.

Maps to :class:crossterm::cursor::SetCursorStyle.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Dataset ¶

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Direction ¶

Layout direction.

Maps to :class:ratatui::layout::Direction. See https://docs.rs/ratatui/0.29.0/ratatui/layout/enum.Direction.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Duration ¶

Effect duration.

Maps to :class:tachyonfx::Duration. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/struct.Duration.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

Effect ¶

Terminal visual effect.

Not thread-safe (unsendable).

Maps to :class:tachyonfx::Effect. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/struct.Effect.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

EffectManager ¶

EffectManager()

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

EffectTimer ¶

Effect timing and interpolation state.

Maps to :class:tachyonfx::EffectTimer. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/struct.EffectTimer.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

EvolveSymbolSet ¶

Symbol progression set for evolve effects.

Maps to :class:tachyonfx::fx::EvolveSymbolSet.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

ExpandDirection ¶

Bidirectional expand direction.

Maps to :class:tachyonfx::fx::ExpandDirection.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Flex ¶

Flex distribution mode for layout constraints.

Maps to :class:ratatui::layout::Flex. See https://docs.rs/ratatui/0.30.2/ratatui/layout/enum.Flex.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Frame ¶

Frame context valid only for the duration of a Terminal.draw callback.

Methods:

hide_cursor –

Hide the terminal cursor for this frame draw pass.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = "Frame context valid only for the duration of a `Terminal.draw` callback."

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

hide_cursor `method descriptor` ¶

hide_cursor() -> None

Hide the terminal cursor for this frame draw pass.

Gauge ¶

Progress gauge widget.

Maps to :class:ratatui::widgets::Gauge. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Gauge.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

GraphType ¶

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

HighlightSpacing ¶

Highlight spacing for list/table widgets.

Maps to :class:ratatui::widgets::HighlightSpacing. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/enum.HighlightSpacing.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Interpolation ¶

Effect interpolation curve.

Maps to :class:tachyonfx::Interpolation. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/enum.Interpolation.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

KeyCode ¶

Key code category.

Maps to :class:crossterm::event::KeyCode.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

KeyEvent ¶

Keyboard event data.

Maps to :class:crossterm::event::KeyEvent.

Methods:

__repr__ –

Return repr(self).
keyboard_kind_str –

Returns "press", "release", or "repeat" — no Python comparison needed.

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

keyboard_kind_str `method descriptor` ¶

keyboard_kind_str() -> (
    Literal["press", "release", "repeat"]
)

Returns "press", "release", or "repeat" — no Python comparison needed.

KeyEventKind ¶

Key event phase.

Maps to :class:crossterm::event::KeyEventKind.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

KeyEventState ¶

Extra keyboard event state flags.

Maps to :class:crossterm::event::KeyEventState.

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

KeyModifiers ¶

Keyboard modifier flags.

Maps to :class:crossterm::event::KeyModifiers.

Methods:

__or__ –

Return self|value.
__repr__ –

Return repr(self).
__ror__ –

Return value|self.

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

or `method descriptor` ¶

__or__(value) -> KeyModifiers

Return self|value.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

ror `method descriptor` ¶

__ror__(value)

Return value|self.

KeyboardEnhancementFlags ¶

Keyboard enhancement protocol flags.

Maps to :class:crossterm::event::KeyboardEnhancementFlags.

Methods:

__or__ –

Return self|value.
__repr__ –

Return repr(self).
__ror__ –

Return value|self.

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

or `method descriptor` ¶

__or__(value) -> KeyboardEnhancementFlags

Return self|value.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

ror `method descriptor` ¶

__ror__(value)

Return value|self.

Layout ¶

Constraint-based layout splitter.

Maps to :class:ratatui::layout::Layout. See https://docs.rs/ratatui/0.29.0/ratatui/layout/struct.Layout.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

LayoutSpacing ¶

Layout child spacing mode.

Classes:

Overlap –
Space –

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Overlap ¶

Bases: xnano_core.rust.native.LayoutSpacing

Classes:

Space –

Methods:

__getitem__ –

Return self[key].
__len__ –

Return len(self).
__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__match_args__ –

Built-in immutable sequence.
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__match_args__ `class-attribute` ¶

__match_args__ = ('_0',)

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Space ¶

Bases: xnano_core.rust.native.LayoutSpacing

Methods:

__getitem__ –

Return self[key].
__len__ –

Return len(self).
__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__match_args__ –

Built-in immutable sequence.
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__match_args__ `class-attribute` ¶

__match_args__ = ('_0',)

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

getitem `method descriptor` ¶

__getitem__(key)

Return self[key].

len `method descriptor` ¶

__len__()

Return len(self).

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

getitem `method descriptor` ¶

__getitem__(key)

Return self[key].

len `method descriptor` ¶

__len__()

Return len(self).

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Space ¶

Bases: xnano_core.rust.native.LayoutSpacing

Classes:

Overlap –

Methods:

__getitem__ –

Return self[key].
__len__ –

Return len(self).
__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__match_args__ –

Built-in immutable sequence.
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__match_args__ `class-attribute` ¶

__match_args__ = ('_0',)

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Overlap ¶

Bases: xnano_core.rust.native.LayoutSpacing

Methods:

__getitem__ –

Return self[key].
__len__ –

Return len(self).
__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__match_args__ –

Built-in immutable sequence.
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__match_args__ `class-attribute` ¶

__match_args__ = ('_0',)

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

getitem `method descriptor` ¶

__getitem__(key)

Return self[key].

len `method descriptor` ¶

__len__()

Return len(self).

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

getitem `method descriptor` ¶

__getitem__(key)

Return self[key].

len `method descriptor` ¶

__len__()

Return len(self).

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

LegendPosition ¶

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Line ¶

A line of styled spans.

Maps to :class:ratatui::text::Line. See https://docs.rs/ratatui/0.29.0/ratatui/text/struct.Line.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

LineGauge ¶

Horizontal line gauge widget.

Maps to :class:ratatui::widgets::LineGauge. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.LineGauge.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

ListDirection ¶

List rendering direction.

Maps to :class:ratatui::widgets::ListDirection. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/enum.ListDirection.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

ListItem ¶

Single list entry.

Maps to :class:ratatui::widgets::ListItem. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.ListItem.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

ListState ¶

ListState()

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.
__repr__ –

Return repr(self).

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

Margin ¶

Margin(horizontal: int = 0, vertical: int = 0)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.
__repr__ –

Return repr(self).

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

Marker ¶

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Modifier ¶

Text style modifier flags.

Maps to :class:ratatui::style::Modifier. See https://docs.rs/ratatui/0.29.0/ratatui/style/struct.Modifier.html

Methods:

__and__ –

Return self&value.
__or__ –

Return self|value.
__rand__ –

Return value&self.
__repr__ –

Return repr(self).
__ror__ –

Return value|self.

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

and `method descriptor` ¶

__and__(value)

Return self&value.

or `method descriptor` ¶

__or__(value) -> Modifier

Return self|value.

rand `method descriptor` ¶

__rand__(value)

Return value&self.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

ror `method descriptor` ¶

__ror__(value)

Return value|self.

Motion ¶

Effect motion direction.

Maps to :class:tachyonfx::Motion. See https://docs.rs/tachyonfx/0.25.0/tachyonfx/enum.Motion.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

MouseButton ¶

Mouse button identifier.

Maps to :class:crossterm::event::MouseButton.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

MouseEvent ¶

Mouse event data.

Maps to :class:crossterm::event::MouseEvent.

Methods:

xnano_button_str –

Returns the xnano-style mouse button string ("left", "right", "middle", "none").
xnano_kind_str –

Returns the xnano-style mouse kind string ("press", "release", "drag",

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

xnano_button_str `method descriptor` ¶

xnano_button_str() -> (
    Literal["left", "right", "middle", "unknown"]
)

Returns the xnano-style mouse button string ("left", "right", "middle", "none").

xnano_kind_str `method descriptor` ¶

xnano_kind_str() -> Literal[
    "press",
    "release",
    "drag",
    "move",
    "scroll_up",
    "scroll_down",
    "scroll_left",
    "scroll_right",
]

Returns the xnano-style mouse kind string ("press", "release", "drag", "move", "scroll_up", "scroll_down", "scroll_left", "scroll_right").

MouseEventKind ¶

Mouse event kind.

Maps to :class:crossterm::event::MouseEventKind.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Offset ¶

Offset(x: int = 0, y: int = 0)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Padding ¶

Block inner padding.

Maps to :class:ratatui::widgets::block::Padding. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/block/struct.Padding.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Paragraph ¶

Multi-line text widget.

Maps to :class:ratatui::widgets::Paragraph. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Paragraph.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

Position ¶

Position(x: int, y: int)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

ORIGIN (Position) –
__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

ORIGIN `class-attribute` ¶

ORIGIN: Position = <xnano_core.rust.native.Position object at 0x7fc766a41670>

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

RadialPattern ¶

Radial spatial pattern for effects.

Maps to :class:tachyonfx::pattern::RadialPattern.

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

RatList ¶

Selectable list widget.

Python name RatList maps to :class:ratatui::widgets::List. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.List.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

RatTable ¶

Table widget.

Python name RatTable maps to :class:ratatui::widgets::Table. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Table.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Rect ¶

Rect(
    x: int = 0, y: int = 0, width: int = 0, height: int = 0
)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.
__repr__ –

Return repr(self).
__str__ –

Return str(self).

Attributes:

ZERO –
__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

ZERO `class-attribute` ¶

ZERO = Rect(x=0, y=0, width=0, height=0)

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

str `method descriptor` ¶

__str__() -> str

Return str(self).

RefRect ¶

Mutable reference to a rectangle area.

Not thread-safe (unsendable).

Maps to :class:tachyonfx::RefRect.

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

RepeatMode ¶

Effect repeat mode.

Maps to :class:tachyonfx::fx::RepeatMode.

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Row ¶

Table row.

Maps to :class:ratatui::widgets::Row. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Row.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

ScrollDirection ¶

Scrollbar scroll direction.

Maps to :class:ratatui::widgets::ScrollDirection. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/enum.ScrollDirection.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Scrollbar ¶

Scrollbar widget.

Maps to :class:ratatui::widgets::Scrollbar. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Scrollbar.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

ScrollbarOrientation ¶

Scrollbar orientation.

Maps to :class:ratatui::widgets::ScrollbarOrientation. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/enum.ScrollbarOrientation.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

ScrollbarState ¶

ScrollbarState(content_length: int)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Size ¶

Size(width: int, height: int)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.
__repr__ –

Return repr(self).

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

Span ¶

Styled text span.

Maps to :class:ratatui::text::Span. See https://docs.rs/ratatui/0.29.0/ratatui/text/struct.Span.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

Sparkline ¶

Sparkline chart widget.

Maps to :class:ratatui::widgets::Sparkline. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Sparkline.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Style ¶

Combined foreground, background, and modifier style.

Maps to :class:ratatui::style::Style. See https://docs.rs/ratatui/0.29.0/ratatui/style/struct.Style.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

TableState ¶

TableState()

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Tabs ¶

Tab bar widget.

Maps to :class:ratatui::widgets::Tabs. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/struct.Tabs.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Terminal ¶

Ratatui terminal handle.

Not thread-safe (unsendable).

Maps to :class:ratatui::DefaultTerminal. See https://docs.rs/ratatui/0.29.0/ratatui/struct.DefaultTerminal.html

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Text ¶

Multi-line styled text.

Maps to :class:ratatui::text::Text. See https://docs.rs/ratatui/0.29.0/ratatui/text/struct.Text.html

Methods:

__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

repr `method descriptor` ¶

__repr__() -> str

Return repr(self).

TitlePosition ¶

Block title position.

Maps to :class:ratatui::widgets::block::Position. See https://docs.rs/ratatui/0.29.0/ratatui/widgets/block/enum.Position.html

Methods:

__eq__ –

Return self==value.
__ge__ –

Return self>=value.
__gt__ –

Return self>value.
__int__ –

int(self)
__le__ –

Return self<=value.
__lt__ –

Return self<value.
__ne__ –

Return self!=value.
__repr__ –

Return repr(self).

Attributes:

__module__ –

str(object='') -> str

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

eq `method descriptor` ¶

__eq__(value)

Return self==value.

ge `method descriptor` ¶

__ge__(value)

Return self>=value.

gt `method descriptor` ¶

__gt__(value)

Return self>value.

int `method descriptor` ¶

__int__()

int(self)

le `method descriptor` ¶

__le__(value)

Return self<=value.

lt `method descriptor` ¶

__lt__(value)

Return self<value.

ne `method descriptor` ¶

__ne__(value)

Return self!=value.

repr `method descriptor` ¶

__repr__()

Return repr(self).

Wrap ¶

Wrap(trim: bool = False)

Methods:

__new__ –

Create and return a new object. See help(type) for accurate signature.

Attributes:

__doc__ –

str(object='') -> str
__module__ –

str(object='') -> str

doc `class-attribute` ¶

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

module `class-attribute` ¶

__module__ = 'xnano_core.rust.native'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

new `builtin` ¶

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

begin_synchronized_update `builtin` ¶

begin_synchronized_update() -> None

Begin a synchronized terminal update.

clear_terminal `builtin` ¶

clear_terminal(clear_type: ClearType) -> None

Clear the terminal using the given clear type.

coalesce `builtin` ¶

coalesce(
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Coalesce effect. See :func:tachyonfx::fx::coalesce.

coalesce_from `builtin` ¶

coalesce_from(
    style: Style,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Coalesce from a style. See :func:tachyonfx::fx::coalesce_from.

color_from_hex `builtin` ¶

color_from_hex(value: str) -> Color

Parse a hex color string (#RGB or #RRGGBB).

color_from_hsl `builtin` ¶

color_from_hsl(h: float, s: float, l: float) -> Color

Create a color from HSL components.

Uses the palette crate; see also https://docs.rs/ratatui/0.29.0/ratatui/style/enum.Color.html#method.from_hsl

color_lerp `builtin` ¶

color_lerp(a: Color, b: Color, t: float) -> Color

Linearly interpolate between two colors.

color_to_hsl `builtin` ¶

color_to_hsl(color: Color) -> tuple[float, float, float]

Convert a color to HSL components (hue in degrees, saturation, lightness).

color_to_srgb `builtin` ¶

color_to_srgb(color: Color) -> tuple[float, float, float]

Convert a color to normalized sRGB components (0.0–1.0).

consume_tick_effect `builtin` ¶

consume_tick_effect() -> Effect

Consume one tick without visual change. See :func:tachyonfx::fx::consume_tick.

darken `builtin` ¶

darken(
    duration_ms: int,
    fg: Optional[float] = None,
    bg: Optional[float] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Darken colors. See :func:tachyonfx::fx::darken.

darken_bg `builtin` ¶

darken_bg(
    bg: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Darken background. Convenience wrapper around :func:darken.

darken_fg `builtin` ¶

darken_fg(
    fg: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Darken foreground. See :func:tachyonfx::fx::darken_fg.

delay_effect `builtin` ¶

delay_effect(duration_ms: int, effect: Effect) -> Effect

Delay before starting an effect. See :func:tachyonfx::fx::delay.

disable_bracketed_paste `builtin` ¶

disable_bracketed_paste() -> None

Disable bracketed paste mode.

disable_cursor_blinking `builtin` ¶

disable_cursor_blinking() -> None

Disable cursor blinking.

disable_focus_change `builtin` ¶

disable_focus_change() -> None

Disable focus change events.

disable_line_wrap `builtin` ¶

disable_line_wrap() -> None

Disable terminal line wrapping.

disable_mouse_capture `builtin` ¶

disable_mouse_capture() -> None

Disable mouse event capture.

disable_raw_mode `builtin` ¶

disable_raw_mode() -> None

Disable terminal raw mode.

dissolve `builtin` ¶

dissolve(
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Dissolve effect. See :func:tachyonfx::fx::dissolve.

dissolve_to `builtin` ¶

dissolve_to(
    style: Style,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Dissolve to a style. See :func:tachyonfx::fx::dissolve_to.

enable_bracketed_paste `builtin` ¶

enable_bracketed_paste() -> None

Enable bracketed paste mode.

enable_cursor_blinking `builtin` ¶

enable_cursor_blinking() -> None

Enable cursor blinking.

enable_focus_change `builtin` ¶

enable_focus_change() -> None

Enable focus change events.

enable_line_wrap `builtin` ¶

enable_line_wrap() -> None

Enable terminal line wrapping.

enable_mouse_capture `builtin` ¶

enable_mouse_capture() -> None

Enable mouse event capture.

enable_raw_mode `builtin` ¶

enable_raw_mode() -> None

Enable terminal raw mode.

end_synchronized_update `builtin` ¶

end_synchronized_update() -> None

End a synchronized terminal update.

enter_alternate_screen `builtin` ¶

enter_alternate_screen() -> None

Switch to the alternate screen buffer.

evolve_effect `builtin` ¶

evolve_effect(
    symbols: EvolveSymbolSet,
    duration_ms: int,
    style: Optional[Style] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Evolve cell symbols. See :func:tachyonfx::fx::evolve.

evolve_from_effect `builtin` ¶

evolve_from_effect(
    symbols: EvolveSymbolSet,
    duration_ms: int,
    style: Optional[Style] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Evolve symbols from source style. See :func:tachyonfx::fx::evolve_from.

evolve_into_effect `builtin` ¶

evolve_into_effect(
    symbols: EvolveSymbolSet,
    duration_ms: int,
    style: Optional[Style] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Evolve symbols into target style. See :func:tachyonfx::fx::evolve_into.

expand_effect `builtin` ¶

expand_effect(
    direction: ExpandDirection,
    style: Style,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Bidirectional expand using block characters. See :func:tachyonfx::fx::expand.

explode_effect `builtin` ¶

explode_effect(
    force: float,
    force_rng_factor: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Explode cells outward. See :func:tachyonfx::fx::explode.

fade_from `builtin` ¶

fade_from(
    fg: Color,
    bg: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Fade from foreground and background colors. See :func:tachyonfx::fx::fade_from.

fade_from_fg `builtin` ¶

fade_from_fg(
    color: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Fade foreground from a color. See :func:tachyonfx::fx::fade_from_fg.

fade_to `builtin` ¶

fade_to(
    fg: Color,
    bg: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Fade to foreground and background colors. See :func:tachyonfx::fx::fade_to.

fade_to_fg `builtin` ¶

fade_to_fg(
    color: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Fade foreground to a color. See :func:tachyonfx::fx::fade_to_fg.

flush_stdout_buffer `builtin` ¶

flush_stdout_buffer() -> None

Flush queued stdout commands.

freeze_at_effect `builtin` ¶

freeze_at_effect(
    alpha: float, set_raw_alpha: bool, effect: Effect
) -> Effect

Freeze an effect at a given alpha. See :func:tachyonfx::fx::freeze_at.

get_cursor_position `builtin` ¶

get_cursor_position() -> Position

Query the current cursor position.

glitch_effect `builtin` ¶

glitch_effect(
    cell_glitch_ratio: float,
    action_start_delay_min_ms: int,
    action_start_delay_max_ms: int,
    action_min_ms: int,
    action_max_ms: int,
    filter: Optional[CellFilter] = None,
    seed: Optional[int] = None,
) -> Effect

Glitch effect with randomized cell mutations. See :class:tachyonfx::fx::Glitch.

hide_cursor `builtin` ¶

hide_cursor() -> None

Hide the terminal cursor.

hsl_shift `builtin` ¶

hsl_shift(
    duration_ms: int,
    fg_h: Optional[float] = None,
    fg_s: Optional[float] = None,
    fg_l: Optional[float] = None,
    bg_h: Optional[float] = None,
    bg_s: Optional[float] = None,
    bg_l: Optional[float] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Shift HSL values. See :func:tachyonfx::fx::hsl_shift.

hsl_shift_bg `builtin` ¶

hsl_shift_bg(
    h: float,
    s: float,
    l: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Shift background HSL. Convenience wrapper around :func:hsl_shift.

hsl_shift_fg `builtin` ¶

hsl_shift_fg(
    h: float,
    s: float,
    l: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Shift foreground HSL. See :func:tachyonfx::fx::hsl_shift_fg.

interpolate_colors `builtin` ¶

interpolate_colors(
    a: Color, b: Color, t: float, space: str = "rgb"
) -> Color

Interpolate between two colors in RGB or HSL space.

is_raw_mode_enabled `builtin` ¶

is_raw_mode_enabled() -> bool

Return whether raw mode is enabled.

leave_alternate_screen `builtin` ¶

leave_alternate_screen() -> None

Leave the alternate screen buffer.

lighten `builtin` ¶

lighten(
    duration_ms: int,
    fg: Optional[float] = None,
    bg: Optional[float] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Lighten colors. See :func:tachyonfx::fx::lighten.

lighten_bg `builtin` ¶

lighten_bg(
    bg: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Lighten background. Convenience wrapper around :func:lighten.

lighten_fg `builtin` ¶

lighten_fg(
    fg: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Lighten foreground. See :func:tachyonfx::fx::lighten_fg.

move_cursor_down `builtin` ¶

move_cursor_down(count: int = 1) -> None

Move the cursor down by count cells.

move_cursor_left `builtin` ¶

move_cursor_left(count: int = 1) -> None

Move the cursor left by count cells.

move_cursor_right `builtin` ¶

move_cursor_right(count: int = 1) -> None

Move the cursor right by count cells.

move_cursor_to `builtin` ¶

move_cursor_to(x: int, y: int) -> None

Move the cursor to (x, y).

move_cursor_to_column `builtin` ¶

move_cursor_to_column(x: int) -> None

Move the cursor to column x on the current row.

move_cursor_to_next_line `builtin` ¶

move_cursor_to_next_line(count: int = 1) -> None

Move the cursor to the next line.

move_cursor_to_previous_line `builtin` ¶

move_cursor_to_previous_line(count: int = 1) -> None

Move the cursor to the previous line.

move_cursor_to_row `builtin` ¶

move_cursor_to_row(y: int) -> None

Move the cursor to row y on the current column.

move_cursor_up `builtin` ¶

move_cursor_up(count: int = 1) -> None

Move the cursor up by count cells.

never_complete_effect `builtin` ¶

never_complete_effect(effect: Effect) -> Effect

Prevent effect from completing. See :func:tachyonfx::fx::never_complete.

paint `builtin` ¶

paint(
    fg: Color,
    bg: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Paint cells to colors. See :func:tachyonfx::fx::paint.

paint_bg `builtin` ¶

paint_bg(
    bg: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Paint background color. See :func:tachyonfx::fx::paint_bg.

paint_fg `builtin` ¶

paint_fg(
    fg: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Paint foreground color. See :func:tachyonfx::fx::paint_fg.

parallel_effects `builtin` ¶

parallel_effects(effects: Sequence[Effect]) -> Effect

Run effects in parallel. See :func:tachyonfx::fx::parallel.

ping_pong_effect `builtin` ¶

ping_pong_effect(effect: Effect) -> Effect

Ping-pong an effect. See :func:tachyonfx::fx::ping_pong.

poll_event `builtin` ¶

poll_event(timeout_ms: int) -> Optional[CoreEvent]

Poll for a terminal event with a timeout in milliseconds.

pop_keyboard_enhancement_flags `builtin` ¶

pop_keyboard_enhancement_flags() -> None

Pop keyboard enhancement flags.

print_styled_content `builtin` ¶

print_styled_content(
    text: str,
    *,
    foreground: Optional[ConsoleColor] = None,
    background: Optional[ConsoleColor] = None,
    attribute: Optional[ConsoleAttribute] = None,
    foreground_ansi: Optional[int] = None,
    background_ansi: Optional[int] = None,
    foreground_rgb: Optional[Tuple[int, int, int]] = None,
    background_rgb: Optional[Tuple[int, int, int]] = None
) -> None

Print styled text to stdout.

print_text `builtin` ¶

print_text(text: str) -> None

Print plain text to stdout.

prolong_end_effect `builtin` ¶

prolong_end_effect(
    duration_ms: int, effect: Effect
) -> Effect

Hold the end state. See :func:tachyonfx::fx::prolong_end.

prolong_start_effect `builtin` ¶

prolong_start_effect(
    duration_ms: int, effect: Effect
) -> Effect

Hold the start state. See :func:tachyonfx::fx::prolong_start.

push_keyboard_enhancement_flags `builtin` ¶

push_keyboard_enhancement_flags(
    flags: KeyboardEnhancementFlags,
) -> None

Push keyboard enhancement flags.

read_event `builtin` ¶

read_event() -> CoreEvent

Block until a terminal event is available.

remap_alpha_effect `builtin` ¶

remap_alpha_effect(
    alpha_start: float, alpha_end: float, effect: Effect
) -> Effect

Remap effect alpha range. See :func:tachyonfx::fx::remap_alpha.

render_stateful_widget `builtin` ¶

render_stateful_widget(
    widget: Any, area: Rect, state: Any, buffer: Buffer
) -> None

Render any supported stateful widget into a buffer region.

render_widget `builtin` ¶

render_widget(
    widget: Any, area: Rect, buffer: Buffer
) -> None

Render any supported widget into a buffer region.

repeat_effect `builtin` ¶

repeat_effect(
    effect: Effect,
    times: Optional[int] = None,
    duration_ms: Optional[int] = None,
) -> Effect

Repeat an effect. See :func:tachyonfx::fx::repeat.

repeating_effect `builtin` ¶

repeating_effect(effect: Effect) -> Effect

Repeat an effect forever. See :func:tachyonfx::fx::repeating.

reset_color `builtin` ¶

reset_color() -> None

Reset console colors to default.

resize_area_effect `builtin` ¶

resize_area_effect(
    initial_size: Size,
    duration_ms: int,
    effect: Optional[Effect] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Resize effect area over time. See :func:tachyonfx::fx::resize_area.

restore_cursor_position `builtin` ¶

restore_cursor_position() -> None

Restore the saved cursor position.

restore_terminal `builtin` ¶

restore_terminal() -> None

Restore the terminal to its pre-ratatui state.

run_once_effect `builtin` ¶

run_once_effect(effect: Effect) -> Effect

Run effect only once. See :func:tachyonfx::fx::run_once.

saturate `builtin` ¶

saturate(
    duration_ms: int,
    fg: Optional[float] = None,
    bg: Optional[float] = None,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Adjust saturation. See :func:tachyonfx::fx::saturate.

saturate_bg `builtin` ¶

saturate_bg(
    bg: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Adjust background saturation. Convenience wrapper around :func:saturate.

saturate_fg `builtin` ¶

saturate_fg(
    fg: float,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Adjust foreground saturation. See :func:tachyonfx::fx::saturate_fg.

save_cursor_position `builtin` ¶

save_cursor_position() -> None

Save the current cursor position.

scroll_down `builtin` ¶

scroll_down(count: int = 1) -> None

Scroll the terminal buffer down.

scroll_up `builtin` ¶

scroll_up(count: int = 1) -> None

Scroll the terminal buffer up.

sequence_effects `builtin` ¶

sequence_effects(effects: Sequence[Effect]) -> Effect

Run effects in sequence. See :func:tachyonfx::fx::sequence.

set_attribute `builtin` ¶

set_attribute(attribute: ConsoleAttribute) -> None

Set a console text attribute.

set_background_color `builtin` ¶

set_background_color(
    color: ConsoleColor,
    *,
    ansi_value: Optional[int] = None,
    rgb: Optional[Tuple[int, int, int]] = None
) -> None

Set the console background color.

set_cursor_style `builtin` ¶

set_cursor_style(style: CursorStyle) -> None

Set the terminal cursor style.

set_foreground_color `builtin` ¶

set_foreground_color(
    color: ConsoleColor,
    *,
    ansi_value: Optional[int] = None,
    rgb: Optional[Tuple[int, int, int]] = None
) -> None

Set the console foreground color.

set_terminal_title `builtin` ¶

set_terminal_title(title: str) -> None

Set the terminal window title.

show_cursor `builtin` ¶

show_cursor() -> None

Show the terminal cursor.

sleep_effect `builtin` ¶

sleep_effect(duration_ms: int) -> Effect

No-op delay effect. See :func:tachyonfx::fx::sleep.

slide_in `builtin` ¶

slide_in(
    direction: Motion,
    gradient_length: int,
    randomness: int,
    color: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Slide effect in. See :func:tachyonfx::fx::slide_in.

slide_out `builtin` ¶

slide_out(
    direction: Motion,
    gradient_length: int,
    randomness: int,
    color: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Slide effect out. See :func:tachyonfx::fx::slide_out.

stretch_effect `builtin` ¶

stretch_effect(
    direction: Motion,
    style: Style,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Unidirectional stretch/shrink using block characters. See :func:tachyonfx::fx::stretch.

styled_span `builtin` ¶

styled_span(
    content: str,
    fg: Optional[Color] = None,
    bg: Optional[Color] = None,
    modifiers: Optional[Modifier] = None,
) -> Span

Create a styled span from a string and style shorthand methods.

supports_keyboard_enhancement `builtin` ¶

supports_keyboard_enhancement() -> bool

Return whether the terminal supports keyboard enhancement.

sweep_in `builtin` ¶

sweep_in(
    direction: Motion,
    gradient_length: int,
    randomness: int,
    color: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Sweep effect in. See :func:tachyonfx::fx::sweep_in.

sweep_out `builtin` ¶

sweep_out(
    direction: Motion,
    gradient_length: int,
    randomness: int,
    color: Color,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Sweep effect out. See :func:tachyonfx::fx::sweep_out.

tailwind_color `builtin` ¶

tailwind_color(name: str, shade: int) -> Color

Look up a Tailwind CSS palette color.

Maps to :class:ratatui::style::palette::tailwind. See https://docs.rs/ratatui/0.29.0/ratatui/style/palette/tailwind/index.html

terminal_size `builtin` ¶

terminal_size() -> Size

Return the terminal size in columns and rows.

terminal_window_size `builtin` ¶

terminal_window_size() -> Size

Return the terminal window size in columns and rows.

timed_never_complete_effect `builtin` ¶

timed_never_complete_effect(
    duration_ms: int, effect: Effect
) -> Effect

Never complete for a bounded duration. See :func:tachyonfx::fx::timed_never_complete.

translate_effect `builtin` ¶

translate_effect(
    effect: Effect,
    translate_by: Offset,
    duration_ms: int,
    interpolation: Optional[Interpolation] = None,
) -> Effect

Translate an effect's area. See :func:tachyonfx::fx::translate.

with_duration_effect `builtin` ¶

with_duration_effect(
    duration_ms: int, effect: Effect
) -> Effect

Override effect duration. See :func:tachyonfx::fx::with_duration.

xnano_core.rust

xnano_core.rust ¶

Alignment ¶

__module__ class-attribute ¶

__eq__ method descriptor ¶

__ge__ method descriptor ¶

__gt__ method descriptor ¶

__int__ method descriptor ¶

__le__ method descriptor ¶

__lt__ method descriptor ¶

__ne__ method descriptor ¶

__repr__ method descriptor ¶

Axis ¶

__module__ class-attribute ¶

Bar ¶

__module__ class-attribute ¶

BarChart ¶

__module__ class-attribute ¶

BarGroup ¶

__module__ class-attribute ¶

Block ¶

__module__ class-attribute ¶

__repr__ method descriptor ¶

BorderSet ¶

__module__ class-attribute ¶

__repr__ method descriptor ¶

BorderType ¶

__module__ class-attribute ¶

__eq__ method descriptor ¶

__ge__ method descriptor ¶

__gt__ method descriptor ¶

__int__ method descriptor ¶

__le__ method descriptor ¶

__lt__ method descriptor ¶

__ne__ method descriptor ¶

__repr__ method descriptor ¶

Borders ¶

__module__ class-attribute ¶

__or__ method descriptor ¶

__repr__ method descriptor ¶

__ror__ method descriptor ¶

Buffer ¶

__module__ class-attribute ¶

__repr__ method descriptor ¶

BufferCell ¶

__module__ class-attribute ¶

__repr__ method descriptor ¶

BufferMutView ¶

__doc__ class-attribute ¶

__module__ class-attribute ¶

Canvas ¶

__module__ class-attribute ¶

Cell ¶

__module__ class-attribute ¶

CellFilter ¶

__module__ class-attribute ¶

Chart ¶

__module__ class-attribute ¶

Clear ¶

__module__ class-attribute ¶

ClearType ¶

__module__ class-attribute ¶

__eq__ method descriptor ¶

__ge__ method descriptor ¶

__gt__ method descriptor ¶

__int__ method descriptor ¶

__le__ method descriptor ¶

__lt__ method descriptor ¶

__ne__ method descriptor ¶

__repr__ method descriptor ¶

Color ¶

__module__ class-attribute ¶

__eq__ method descriptor ¶

__ge__ method descriptor ¶

__gt__ method descriptor ¶

__hash__ method descriptor ¶

__le__ method descriptor ¶

__lt__ method descriptor ¶

__ne__ method descriptor ¶

__repr__ method descriptor ¶

module `class-attribute` ¶

eq `method descriptor` ¶

ge `method descriptor` ¶

gt `method descriptor` ¶

int `method descriptor` ¶

le `method descriptor` ¶

lt `method descriptor` ¶

ne `method descriptor` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

eq `method descriptor` ¶

ge `method descriptor` ¶

gt `method descriptor` ¶

int `method descriptor` ¶

le `method descriptor` ¶

lt `method descriptor` ¶

ne `method descriptor` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

or `method descriptor` ¶

repr `method descriptor` ¶

ror `method descriptor` ¶

module `class-attribute` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

repr `method descriptor` ¶

doc `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

eq `method descriptor` ¶

ge `method descriptor` ¶

gt `method descriptor` ¶

int `method descriptor` ¶

le `method descriptor` ¶

lt `method descriptor` ¶

ne `method descriptor` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

eq `method descriptor` ¶

ge `method descriptor` ¶

gt `method descriptor` ¶

hash `method descriptor` ¶

le `method descriptor` ¶

lt `method descriptor` ¶

ne `method descriptor` ¶

repr `method descriptor` ¶

module `class-attribute` ¶

eq `method descriptor` ¶

ge `method descriptor` ¶

gt `method descriptor` ¶

int `method descriptor` ¶

le `method descriptor` ¶

lt `method descriptor` ¶

ne `method descriptor` ¶

repr `method descriptor` ¶

doc `class-attribute` ¶

module `class-attribute` ¶

module `class-attribute` ¶

eq `method descriptor` ¶

ge `method descriptor` ¶

gt `method descriptor` ¶

int `method descriptor` ¶

le `method descriptor` ¶

lt `method descriptor` ¶

ne `method descriptor` ¶

repr `method descriptor` ¶

module `class-attribute` ¶