Struct Composer 

pub struct Composer { /* private fields */ }

Implementations

impl Composer

pub fn on_resize(&mut self, width: u16)

Adopts a new terminal width, so wrapping and vertical cursor movement follow the rows the next layout will produce.

pub fn layout(&self, width: u16, theme: &Theme) -> ComposerLayout

Lays the composer out for width columns: a rule, the wrapped input with its @mentions highlighted, any attachments, and a closing rule.

impl Composer

pub fn new() -> Self

pub fn text(&self) -> &str

pub fn is_empty(&self) -> bool

pub fn selected_mentions(&self) -> Vec<SelectedFileMention>

pub fn take_submission(&mut self) -> (String, Vec<PromptAttachment>)

pub fn clear(&mut self)

pub fn add_dropped_media(&mut self, paths: Vec<PathBuf>) -> bool

pub fn pending_media(&self) -> &[PromptAttachment]

pub fn apply_edit_key(&mut self, key: KeyEvent) -> bool

Applies one shared editing keystroke. Anything that changes the text also ends history navigation, so the recalled prompt becomes the user’s draft.

pub fn insert_char(&mut self, character: char)

pub fn insert_str(&mut self, text: &str)

pub fn insert_paste(&mut self, text: &str)

pub fn insert_newline(&mut self)

pub fn backspace(&mut self)

pub fn move_left(&mut self)

pub fn move_line_start(&mut self)

pub fn move_line_end(&mut self)

pub fn move_up(&mut self) -> bool

Moves the cursor to the visual row above, reporting whether there was one. A long line the composer soft-wrapped has rows above without any newline before the cursor, so this follows what is on screen rather than the newlines in the text.

pub fn move_down(&mut self) -> bool

Moves the cursor to the visual row below, reporting whether there was one.

pub fn recall_previous(&mut self) -> bool

pub fn recall_next(&mut self) -> bool

pub fn open_command_picker(&mut self, commands: Vec<CommandEntry>)

pub fn open_file_picker(&mut self, root: &Path) -> FilesystemCommand

Opens the @ picker and asks for the file index it will show. The walk runs off the event loop, so opening the picker never stalls the keystroke that triggered it.

pub fn on_files_indexed(&mut self, request_id: RequestId, files: Vec<FileEntry>)

pub fn has_completion(&self) -> bool

pub fn completion(&self) -> Option<&CompletionOverlay>

pub fn completion_mut(&mut self) -> Option<&mut CompletionOverlay>

The open completion list, for navigation and stateful rendering.

pub fn prompt_search(&self) -> Option<&PromptSearchPicker>

pub fn prompt_search_mut(&mut self) -> Option<&mut PromptSearchPicker>

The open prompt-history picker, for queries and stateful rendering.

pub fn has_open_overlay(&self) -> bool

pub fn on_overlay_mouse(&mut self, action: MouseAction, row: u16)

Routes a mouse event to whichever overlay is open. Browsing history results previews each candidate in the composer, the way the arrow keys do.

pub fn has_prompt_search(&self) -> bool

pub fn open_prompt_search(&mut self)

pub fn on_prompt_search_key(&mut self, key: KeyEvent) -> Option<ComposerOutcome>

Applies a keystroke to the open history search, or reports that there is none for it to go to.

pub fn on_prompt_search_paste(&mut self, text: &str) -> Option<ComposerOutcome>

Applies a paste to the open history search, or reports that there is none for it to go to.

pub fn on_completion_key(&mut self, key: KeyEvent) -> Option<ComposerOutcome>

Applies a keystroke to the open completion list, or reports that there is none for it to go to.

pub fn prompt_search_on_results(&mut self, response: PromptSearchResponse)

pub fn accept_command(&mut self) -> Option<CommandEntry>

pub fn accept_file(&mut self) -> Option<FileEntry>

pub fn refresh_overlay_query(&mut self)

pub fn cursor_position(&self) -> (usize, usize)

Trait Implementations

impl Debug for Composer

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

Formats the value using the given formatter.

impl Default for Composer

fn default() -> Composer

Returns the “default value” for a type.