Skip to main content

Action

Enum Action 

Source
pub enum Action {
Show 323 variants InsertChar(char), InsertNewline, InsertTab, MoveLeft, MoveRight, MoveUp, MoveDown, MoveWordLeft, MoveWordRight, MoveWordEnd, ViMoveWordEnd, MoveLeftInLine, MoveRightInLine, MoveLineStart, MoveLineEnd, MoveLineUp, MoveLineDown, MovePageUp, MovePageDown, MoveDocumentStart, MoveDocumentEnd, SelectLeft, SelectRight, SelectUp, SelectDown, SelectToParagraphUp, SelectToParagraphDown, SelectWordLeft, SelectWordRight, SelectWordEnd, ViSelectWordEnd, SelectLineStart, SelectLineEnd, SelectDocumentStart, SelectDocumentEnd, SelectPageUp, SelectPageDown, SelectAll, SelectWord, SelectLine, ExpandSelection, BlockSelectLeft, BlockSelectRight, BlockSelectUp, BlockSelectDown, DeleteBackward, DeleteForward, DeleteWordBackward, DeleteWordForward, DeleteLine, DeleteToLineEnd, DeleteToLineStart, DeleteViWordEnd, TransposeChars, OpenLine, DuplicateLine, Recenter, SetMark, Copy, CopyWithTheme(String), Cut, Paste, CopyFilePath, CopyRelativeFilePath, YankWordForward, YankWordBackward, YankToLineEnd, YankToLineStart, YankViWordEnd, AddCursorAbove, AddCursorBelow, AddCursorNextMatch, AddCursorsToLineEnds, RemoveSecondaryCursors, Save, SaveAs, Open, SwitchProject, New, Close, CloseTab, Quit, ForceQuit, Detach, Revert, ToggleAutoRevert, FormatBuffer, TrimTrailingWhitespace, EnsureFinalNewline, GotoLine, ScanLineIndex, GoToMatchingBracket, JumpToNextError, JumpToPreviousError, SmartHome, DedentSelection, ToggleComment, DabbrevExpand, ToggleFold, SetBookmark(char), JumpToBookmark(char), ClearBookmark(char), ListBookmarks, ToggleSearchCaseSensitive, ToggleSearchWholeWord, ToggleSearchRegex, ToggleSearchConfirmEach, StartMacroRecording, StopMacroRecording, PlayMacro(char), ToggleMacroRecording(char), ShowMacro(char), ListMacros, PromptRecordMacro, PromptPlayMacro, PlayLastMacro, PromptSetBookmark, PromptJumpToBookmark, Undo, Redo, ScrollUp, ScrollDown, ShowHelp, ShowKeyboardShortcuts, ShowWarnings, ShowStatusLog, ShowLspStatus, ShowRemoteIndicatorMenu, ClearWarnings, CommandPalette, QuickOpen, QuickOpenBuffers, QuickOpenFiles, OpenLiveGrep, ResumeLiveGrep, LiveGrepExportQuickfix, ToggleUtilityDock, OpenTerminalInDock, CycleLiveGrepProvider, ToggleLineWrap, ToggleCurrentLineHighlight, ToggleReadOnly, TogglePageView, SetPageWidth, InspectThemeAtCursor, SelectTheme, SelectKeybindingMap, SelectCursorStyle, SelectLocale, NextBuffer, PrevBuffer, SwitchToPreviousTab, SwitchToTabByName, ScrollTabsLeft, ScrollTabsRight, NavigateBack, NavigateForward, SplitHorizontal, SplitVertical, CloseSplit, NextSplit, PrevSplit, IncreaseSplitSize, DecreaseSplitSize, ToggleMaximizeSplit, PromptConfirm, PromptConfirmWithText(String), PromptCancel, PromptBackspace, PromptDelete, PromptMoveLeft, PromptMoveRight, PromptMoveStart, PromptMoveEnd, PromptSelectPrev, PromptSelectNext, PromptPageUp, PromptPageDown, PromptAcceptSuggestion, PromptMoveWordLeft, PromptMoveWordRight, PromptDeleteWordForward, PromptDeleteWordBackward, PromptDeleteToLineEnd, PromptCopy, PromptCut, PromptPaste, PromptMoveLeftSelecting, PromptMoveRightSelecting, PromptMoveHomeSelecting, PromptMoveEndSelecting, PromptSelectWordLeft, PromptSelectWordRight, PromptSelectAll, FileBrowserToggleHidden, FileBrowserToggleDetectEncoding, PopupSelectNext, PopupSelectPrev, PopupPageUp, PopupPageDown, PopupConfirm, PopupCancel, PopupFocus, CompletionAccept, CompletionDismiss, ToggleFileExplorer, ToggleMenuBar, ToggleTabBar, ToggleStatusBar, TogglePromptLine, ToggleVerticalScrollbar, ToggleHorizontalScrollbar, FocusFileExplorer, FocusEditor, FileExplorerUp, FileExplorerDown, FileExplorerPageUp, FileExplorerPageDown, FileExplorerExpand, FileExplorerCollapse, FileExplorerOpen, FileExplorerRefresh, FileExplorerNewFile, FileExplorerNewDirectory, FileExplorerDelete, FileExplorerRename, FileExplorerToggleHidden, FileExplorerToggleGitignored, FileExplorerSearchClear, FileExplorerSearchBackspace, FileExplorerCopy, FileExplorerCut, FileExplorerPaste, FileExplorerDuplicate, FileExplorerCopyFullPath, FileExplorerCopyRelativePath, FileExplorerExtendSelectionUp, FileExplorerExtendSelectionDown, FileExplorerToggleSelect, FileExplorerSelectAll, LspCompletion, LspGotoDefinition, LspReferences, LspRename, LspHover, LspSignatureHelp, LspCodeActions, LspRestart, LspStop, LspToggleForBuffer, ToggleInlayHints, ToggleMouseHover, ToggleLineNumbers, ToggleScrollSync, ToggleMouseCapture, ToggleDebugHighlights, SetBackground, SetBackgroundBlend, SetTabSize, SetLineEnding, SetEncoding, ReloadWithEncoding, SetLanguage, ToggleIndentationStyle, ToggleTabIndicators, ToggleWhitespaceIndicators, ResetBufferSettings, AddRuler, RemoveRuler, DumpConfig, RedrawScreen, Search, FindInSelection, FindNext, FindPrevious, FindSelectionNext, FindSelectionPrevious, Replace, QueryReplace, MenuActivate, MenuClose, MenuLeft, MenuRight, MenuUp, MenuDown, MenuExecute, MenuOpen(String), SwitchKeybindingMap(String), PluginAction(String), OpenSettings, CloseSettings, SettingsSave, SettingsReset, SettingsToggleFocus, SettingsActivate, SettingsSearch, SettingsHelp, SettingsIncrement, SettingsDecrement, SettingsInherit, OpenTerminal, CloseTerminal, FocusTerminal, TerminalEscape, ToggleKeyboardCapture, TerminalPaste, ShellCommand, ShellCommandReplace, ToUpperCase, ToLowerCase, ToggleCase, SortLines, CalibrateInput, EventDebug, SuspendProcess, OpenKeybindingEditor, LoadPluginFromBuffer, InitReload, InitEdit, InitCheck, CompositeNextHunk, CompositePrevHunk, None,
}
Expand description

High-level actions that can be performed in the editor

Variants§

§

InsertChar(char)

§

InsertNewline

§

InsertTab

§

MoveLeft

§

MoveRight

§

MoveUp

§

MoveDown

§

MoveWordLeft

§

MoveWordRight

§

MoveWordEnd

§

ViMoveWordEnd

§

MoveLeftInLine

§

MoveRightInLine

§

MoveLineStart

§

MoveLineEnd

§

MoveLineUp

§

MoveLineDown

§

MovePageUp

§

MovePageDown

§

MoveDocumentStart

§

MoveDocumentEnd

§

SelectLeft

§

SelectRight

§

SelectUp

§

SelectDown

§

SelectToParagraphUp

§

SelectToParagraphDown

§

SelectWordLeft

§

SelectWordRight

§

SelectWordEnd

§

ViSelectWordEnd

§

SelectLineStart

§

SelectLineEnd

§

SelectDocumentStart

§

SelectDocumentEnd

§

SelectPageUp

§

SelectPageDown

§

SelectAll

§

SelectWord

§

SelectLine

§

ExpandSelection

§

BlockSelectLeft

§

BlockSelectRight

§

BlockSelectUp

§

BlockSelectDown

§

DeleteBackward

§

DeleteForward

§

DeleteWordBackward

§

DeleteWordForward

§

DeleteLine

§

DeleteToLineEnd

§

DeleteToLineStart

§

DeleteViWordEnd

§

TransposeChars

§

OpenLine

§

DuplicateLine

§

Recenter

§

SetMark

§

Copy

§

CopyWithTheme(String)

§

Cut

§

Paste

§

CopyFilePath

Copy the absolute filesystem path of the active buffer’s file to the clipboard.

§

CopyRelativeFilePath

Copy the active buffer’s file path relative to the workspace root, falling back to the absolute path if the file lives outside the workspace.

§

YankWordForward

§

YankWordBackward

§

YankToLineEnd

§

YankToLineStart

§

YankViWordEnd

§

AddCursorAbove

§

AddCursorBelow

§

AddCursorNextMatch

§

AddCursorsToLineEnds

§

RemoveSecondaryCursors

§

Save

§

SaveAs

§

Open

§

SwitchProject

§

New

§

Close

§

CloseTab

§

Quit

§

ForceQuit

§

Detach

§

Revert

§

ToggleAutoRevert

§

FormatBuffer

§

TrimTrailingWhitespace

§

EnsureFinalNewline

§

GotoLine

§

ScanLineIndex

§

GoToMatchingBracket

§

JumpToNextError

§

JumpToPreviousError

§

SmartHome

§

DedentSelection

§

ToggleComment

§

DabbrevExpand

§

ToggleFold

§

SetBookmark(char)

§

JumpToBookmark(char)

§

ClearBookmark(char)

§

ListBookmarks

§

ToggleSearchCaseSensitive

§

ToggleSearchWholeWord

§

ToggleSearchRegex

§

ToggleSearchConfirmEach

§

StartMacroRecording

§

StopMacroRecording

§

PlayMacro(char)

§

ToggleMacroRecording(char)

§

ShowMacro(char)

§

ListMacros

§

PromptRecordMacro

§

PromptPlayMacro

§

PlayLastMacro

§

PromptSetBookmark

§

PromptJumpToBookmark

§

Undo

§

Redo

§

ScrollUp

§

ScrollDown

§

ShowHelp

§

ShowKeyboardShortcuts

§

ShowWarnings

§

ShowStatusLog

§

ShowLspStatus

§

ShowRemoteIndicatorMenu

§

ClearWarnings

§

CommandPalette

§

QuickOpen

Quick Open - unified prompt with prefix-based provider routing

§

QuickOpenBuffers

Quick Open - buffers (prefix: “#”)

§

QuickOpenFiles

Quick Open - files (empty prefix)

§

OpenLiveGrep

Open Live Grep as a floating overlay (issue #1796).

§

ResumeLiveGrep

Re-open Live Grep with the prior query and selection.

§

LiveGrepExportQuickfix

Export the Live Grep overlay’s current results into the Utility Dock as a Quickfix list. Only fires when the active prompt is PromptType::LiveGrep.

§

ToggleUtilityDock

Toggle focus on the Utility Dock. If the dock exists and is not focused, focus it. If it is focused, return focus to the previously active editor split.

§

OpenTerminalInDock

Open a terminal inside the Utility Dock (creates the dock if absent; otherwise swaps the active dock buffer to a terminal).

§

CycleLiveGrepProvider

Switch the Live Grep overlay to the next available registered search provider (skipping unavailable ones), then re-run the current query under it. Plumbs through to the live_grep_cycle_provider plugin handler.

§

ToggleLineWrap

§

ToggleCurrentLineHighlight

§

ToggleReadOnly

§

TogglePageView

§

SetPageWidth

§

InspectThemeAtCursor

§

SelectTheme

§

SelectKeybindingMap

§

SelectCursorStyle

§

SelectLocale

§

NextBuffer

§

PrevBuffer

§

SwitchToPreviousTab

§

SwitchToTabByName

§

ScrollTabsLeft

§

ScrollTabsRight

§

NavigateBack

§

NavigateForward

§

SplitHorizontal

§

SplitVertical

§

CloseSplit

§

NextSplit

§

PrevSplit

§

IncreaseSplitSize

§

DecreaseSplitSize

§

ToggleMaximizeSplit

§

PromptConfirm

§

PromptConfirmWithText(String)

PromptConfirm with recorded text for macro playback

§

PromptCancel

§

PromptBackspace

§

PromptDelete

§

PromptMoveLeft

§

PromptMoveRight

§

PromptMoveStart

§

PromptMoveEnd

§

PromptSelectPrev

§

PromptSelectNext

§

PromptPageUp

§

PromptPageDown

§

PromptAcceptSuggestion

§

PromptMoveWordLeft

§

PromptMoveWordRight

§

PromptDeleteWordForward

§

PromptDeleteWordBackward

§

PromptDeleteToLineEnd

§

PromptCopy

§

PromptCut

§

PromptPaste

§

PromptMoveLeftSelecting

§

PromptMoveRightSelecting

§

PromptMoveHomeSelecting

§

PromptMoveEndSelecting

§

PromptSelectWordLeft

§

PromptSelectWordRight

§

PromptSelectAll

§

FileBrowserToggleHidden

§

FileBrowserToggleDetectEncoding

§

PopupSelectNext

§

PopupSelectPrev

§

PopupPageUp

§

PopupPageDown

§

PopupConfirm

§

PopupCancel

§

PopupFocus

Transfer keyboard focus to the topmost visible popup. LSP popups are shown unfocused (so they don’t silently swallow keystrokes); this action lets the user grab them with the keyboard. Default binding is Alt+T and is configurable via the keybinding map.

§

CompletionAccept

§

CompletionDismiss

§

ToggleFileExplorer

§

ToggleMenuBar

§

ToggleTabBar

§

ToggleStatusBar

§

TogglePromptLine

§

ToggleVerticalScrollbar

§

ToggleHorizontalScrollbar

§

FocusFileExplorer

§

FocusEditor

§

FileExplorerUp

§

FileExplorerDown

§

FileExplorerPageUp

§

FileExplorerPageDown

§

FileExplorerExpand

§

FileExplorerCollapse

§

FileExplorerOpen

§

FileExplorerRefresh

§

FileExplorerNewFile

§

FileExplorerNewDirectory

§

FileExplorerDelete

§

FileExplorerRename

§

FileExplorerToggleHidden

§

FileExplorerToggleGitignored

§

FileExplorerSearchClear

§

FileExplorerSearchBackspace

§

FileExplorerCopy

§

FileExplorerCut

§

FileExplorerPaste

§

FileExplorerDuplicate

§

FileExplorerCopyFullPath

§

FileExplorerCopyRelativePath

§

FileExplorerExtendSelectionUp

§

FileExplorerExtendSelectionDown

§

FileExplorerToggleSelect

§

FileExplorerSelectAll

§

LspCompletion

§

LspGotoDefinition

§

LspReferences

§

LspRename

§

LspHover

§

LspSignatureHelp

§

LspCodeActions

§

LspRestart

§

LspStop

§

LspToggleForBuffer

§

ToggleInlayHints

§

ToggleMouseHover

§

ToggleLineNumbers

§

ToggleScrollSync

§

ToggleMouseCapture

§

ToggleDebugHighlights

§

SetBackground

§

SetBackgroundBlend

§

SetTabSize

§

SetLineEnding

§

SetEncoding

§

ReloadWithEncoding

§

SetLanguage

§

ToggleIndentationStyle

§

ToggleTabIndicators

§

ToggleWhitespaceIndicators

§

ResetBufferSettings

§

AddRuler

§

RemoveRuler

§

DumpConfig

§

RedrawScreen

§

Search

§

FindInSelection

§

FindNext

§

FindPrevious

§

FindSelectionNext

§

FindSelectionPrevious

§

Replace

§

QueryReplace

§

MenuActivate

§

MenuClose

§

MenuLeft

§

MenuRight

§

MenuUp

§

MenuDown

§

MenuExecute

§

MenuOpen(String)

§

SwitchKeybindingMap(String)

§

PluginAction(String)

§

OpenSettings

§

CloseSettings

§

SettingsSave

§

SettingsReset

§

SettingsToggleFocus

§

SettingsActivate

§

SettingsSearch

§

SettingsHelp

§

SettingsIncrement

§

SettingsDecrement

§

SettingsInherit

§

OpenTerminal

§

CloseTerminal

§

FocusTerminal

§

TerminalEscape

§

ToggleKeyboardCapture

§

TerminalPaste

§

ShellCommand

§

ShellCommandReplace

§

ToUpperCase

§

ToLowerCase

§

ToggleCase

§

SortLines

§

CalibrateInput

§

EventDebug

§

SuspendProcess

§

OpenKeybindingEditor

§

LoadPluginFromBuffer

§

InitReload

§

InitEdit

§

InitCheck

§

CompositeNextHunk

§

CompositePrevHunk

§

None

Implementations§

Source§

impl Action

Source

pub fn from_str(s: &str, args: &HashMap<String, Value>) -> Option<Self>

Parse action from string (used when loading from config)

Source

pub fn to_action_str(&self) -> String

Convert an action back to its string name (inverse of from_str). Returns the canonical action name string.

Source

pub fn all_action_names() -> Vec<String>

All valid action name strings, sorted alphabetically. Generated from the same macro as from_str, guaranteeing compile-time completeness.

Source

pub fn variant_arg_key(bare_action: &str) -> Option<&'static str>

For action names whose string form takes a string-typed arg, return the arg-map key that carries the variant value (e.g. menu_open"name"). Returns None for actions with no enumerable string variant.

Drives the keybinding editor’s qualified-name syntax (menu_open:File{action: "menu_open", args: {name: "File"}}).

Source

pub fn qualify_action( bare_action: &str, args: &HashMap<String, Value>, ) -> String

Collapse an (action, args) pair into a qualified action string. Parameterised actions with a string variant become bare:value (e.g. menu_open:File); everything else is returned unchanged.

Source

pub fn to_qualified_action_str(&self) -> String

Qualified string for this Action value — the inverse of Self::unqualify_action. Used when we already hold an Action enum (e.g. from a plugin mode’s default bindings) and want the same qualified form the editor uses elsewhere.

Source

pub fn unqualify_action(qualified: &str) -> (String, HashMap<String, Value>)

Inverse of [qualify_action]: split a qualified action string into the bare action name and the args map it implies. For unqualified strings (or suffix syntax used on an action with no variant arg) returns the input unchanged with empty args.

Source

pub fn is_movement_or_editing(&self) -> bool

Check if this action is a movement or editing action that should be ignored in virtual buffers with hidden cursors.

Source

pub fn is_editing(&self) -> bool

Check if this action modifies buffer content (for block selection conversion). Block selections should be converted to multi-cursor before these actions.

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Action

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Action

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Action

Source§

fn eq(&self, other: &Action) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Action

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Action

Source§

impl StructuralPartialEq for Action

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryClone for T
where T: Clone,

Source§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ParallelSend for T