Struct requestty_ui::widgets::Prompt

pub struct Prompt<M, H = &'static str> { /* fields omitted */ }

A generic prompt that renders a message and an optional hint.

Implementations

impl<M: AsRef<str>, H: AsRef<str>> Prompt<M, H>

pub fn new(message: M) -> Self

Creates a new Prompt

pub fn with_hint(self, hint: H) -> Self

Sets the hint

pub fn with_optional_hint(self, hint: Option<H>) -> Self

Sets the hint

pub fn with_delim(self, delim: Delimiter) -> Self

Sets the hint delimiter

pub fn message(&self) -> &M

Get the message

pub fn hint(&self) -> Option<&H>

Get the hint

pub fn delim(&self) -> Delimiter

Get the delimiter

pub fn into_message(self) -> M

Consume self returning the owned message

pub fn into_hint(self) -> Option<H>

Consume self returning the owned hint

pub fn into_message_and_hint(self) -> (M, Option<H>)

Consume self returning the owned message and hint

pub fn message_len(&self) -> u16

The character length of the message

pub fn hint_len(&self) -> u16

The character length of the hint. It is 0 if the hint is absent

pub fn width(&self) -> u16

The character length of the fully rendered prompt

impl<M: AsRef<str>> Prompt<M, &'static str>

pub fn write_finished_message<B: Backend>(
    message: &M,
    backend: &mut B
) -> Result<()>

The end prompt to be printed once the question is answered.

Trait Implementations

impl<M: Clone, H: Clone> Clone for Prompt<M, H>

fn clone(&self) -> Prompt<M, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug, H: Debug> Debug for Prompt<M, H>

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

Formats the value using the given formatter.

impl<M: AsRef<str>, H: AsRef<str>> Widget for Prompt<M, H>

fn render<B: Backend>(&mut self, layout: &mut Layout, b: &mut B) -> Result<()>

Render to a given backend.

fn height(&mut self, layout: &mut Layout) -> u16

The number of rows of the terminal the widget will take when rendered.

fn cursor_pos(&mut self, layout: Layout) -> (u16, u16)

The position of the cursor to be placed at after render. The returned value should be in the form of (x, y), with (0, 0) being the top left of the screen.

fn handle_key(&mut self, _: KeyEvent) -> bool

Handle a key input. It should return whether key was handled.