Struct requestty_ui::widgets::Prompt

source · [−]

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

Expand description

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

Implementations

source

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

source

pub fn new(message: M) -> Self

Creates a new Prompt

source

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

Sets the hint

source

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

Sets the hint

source

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

Sets the hint delimiter

source

pub fn message(&self) -> &M

Get the message

source

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

Get the hint

source

pub fn delim(&self) -> Delimiter

Get the delimiter

source

pub fn into_message(self) -> M

Consume self returning the owned message

source

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

Consume self returning the owned hint

source

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

Consume self returning the owned message and hint

source

pub fn message_len(&self) -> u16

The character length of the message

source

pub fn hint_len(&self) -> u16

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

source

pub fn width(&self) -> u16

The character length of the fully rendered prompt

source

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

source

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

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

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

Render to a given backend. Read more

source

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

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

source

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. Read more

source

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

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

Auto Trait Implementations

impl<M, H> RefUnwindSafe for Prompt<M, H> where
H: RefUnwindSafe,
M: RefUnwindSafe,

impl<M, H> Send for Prompt<M, H> where
H: Send,
M: Send,

impl<M, H> Sync for Prompt<M, H> where
H: Sync,
M: Sync,

impl<M, H> Unpin for Prompt<M, H> where
H: Unpin,
M: Unpin,

impl<M, H> UnwindSafe for Prompt<M, H> where
H: UnwindSafe,
M: UnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct requestty_ui::widgets::Prompt

Implementations

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

pub fn new(message: M) -> Self

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

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

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

pub fn message(&self) -> &M

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

pub fn delim(&self) -> Delimiter

pub fn into_message(self) -> M

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

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

pub fn message_len(&self) -> u16

pub fn hint_len(&self) -> u16

pub fn width(&self) -> u16

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

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

Trait Implementations

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

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

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

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

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

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<()>

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

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

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

Auto Trait Implementations

impl<M, H> RefUnwindSafe for Prompt<M, H> where H: RefUnwindSafe, M: RefUnwindSafe,

impl<M, H> Send for Prompt<M, H> where H: Send, M: Send,

impl<M, H> Sync for Prompt<M, H> where H: Sync, M: Sync,

impl<M, H> Unpin for Prompt<M, H> where H: Unpin, M: Unpin,

impl<M, H> UnwindSafe for Prompt<M, H> where H: UnwindSafe, M: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

impl<M, H> RefUnwindSafe for Prompt<M, H> where
H: RefUnwindSafe,
M: RefUnwindSafe,

impl<M, H> Send for Prompt<M, H> where
H: Send,
M: Send,

impl<M, H> Sync for Prompt<M, H> where
H: Sync,
M: Sync,

impl<M, H> Unpin for Prompt<M, H> where
H: Unpin,
M: Unpin,

impl<M, H> UnwindSafe for Prompt<M, H> where
H: UnwindSafe,
M: UnwindSafe,

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

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

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

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

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

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

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