Struct InputField 

pub struct InputField { /* private fields */ }

Represents a user input field.

Implementations

impl InputField

pub const fn new() -> Self

Creates a new InputField.

pub fn new_hidden() -> Self

Creates a new hidden InputField.

pub fn create<'c, C: Into<Cow<'c, str>>>(title: C) -> Self

Creates a new InputField with the provided title.

pub fn create_hidden<'c, C: Into<Cow<'c, str>>>(title: C) -> Self

Creates a new InputField with the provided title.

pub fn state_mut(&mut self) -> &mut InputState

Gets a mutable reference to the input state.

pub fn cursor_position(&self, index: usize) -> Position

Gets the cursor position of the input field, based on it’s index in a list.

pub async fn run( &mut self, terminal: &mut DefaultTerminal, events: &mut EventHandler, ) -> Result<String>

Runs an event loop for the InputField.

pub fn as_widget(&self) -> Paragraph<'_>

Converts the InputField into a TUI widget.

pub fn constraint(&self) -> Constraint

Gets the layout constraint required to render the InputField.

impl InputField

pub fn input(&self) -> &str

Gets the InputField input.

pub fn set_input<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the InputField input.

pub fn with_input<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the InputField input.

pub fn title(&self) -> &str

Gets the InputField title.

pub fn set_title<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the InputField title.

pub fn with_title<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the InputField title.

impl InputField

pub fn state(&self) -> &InputState

Gets the InputField state.

pub fn set_state(&mut self, val: InputState)

Sets the InputField state.

pub fn with_state(self, val: InputState) -> Self

Builder function that sets the InputField state.

Trait Implementations

impl Clone for InputField

fn clone(&self) -> InputField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputField

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

Formats the value using the given formatter.

impl Default for InputField

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for InputField

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Widget for &InputField

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl Zeroize for InputField

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for InputField

impl StructuralPartialEq for InputField