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 create<'c, C: Into<Cow<'c, str>>>(title: C) -> Self

Creates a new InputField with the provided title.

pub fn title(&self) -> &str

Gets the InputField title.

pub fn run(&mut self, terminal: &mut DefaultTerminal) -> 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 const fn input_mode(&self) -> InputMode

Gets the InputField input_mode.

pub fn set_input_mode(&mut self, val: InputMode)

Sets the InputField input_mode.

pub fn with_input_mode(self, val: InputMode) -> Self

Builder function that sets the InputField input_mode.

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 Eq for InputField

impl StructuralPartialEq for InputField