Skip to main content

Input

Struct Input 

Source
pub struct Input<'a, Message> { /* private fields */ }
Available on crate feature input only.
Expand description

A text input builder. Convert it into an Element to render.

An input without an on_input message is rendered disabled.

Implementations§

Source§

impl<'a, Message> Input<'a, Message>

Source

pub fn id(self, id: impl Into<Id>) -> Self

Sets the widget id, used to focus the input or find it in tests.

Source

pub fn on_input(self, on_input: impl Fn(String) -> Message + 'a) -> Self

Sets the message produced for every edit. Without it the input is disabled.

Source

pub fn on_input_maybe( self, on_input: Option<impl Fn(String) -> Message + 'a>, ) -> Self

Source

pub fn on_submit(self, message: Message) -> Self

Sets the message produced when Enter is pressed.

Source

pub fn on_submit_maybe(self, message: Option<Message>) -> Self

Source

pub fn icon(self, glyph: Glyph) -> Self

Adds a Lucide icon at the start of the input.

Source

pub fn secure(self, secure: bool) -> Self

Masks the value, for passwords and other secrets.

Source

pub fn invalid(self, invalid: bool) -> Self

Marks the value as invalid, drawing a destructive border.

Source

pub fn size(self, size: Size) -> Self

Source

pub fn width(self, width: impl Into<Length>) -> Self

Overrides the width. Inputs fill the available width by default.

Source

pub fn is_enabled(&self) -> bool

Trait Implementations§

Source§

impl<Message: Debug> Debug for Input<'_, Message>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, Message: Clone + 'a> From<Input<'a, Message>> for Element<'a, Message>

Source§

fn from(input: Input<'a, Message>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a, Message> !RefUnwindSafe for Input<'a, Message>

§

impl<'a, Message> !Send for Input<'a, Message>

§

impl<'a, Message> !Sync for Input<'a, Message>

§

impl<'a, Message> !UnwindSafe for Input<'a, Message>

§

impl<'a, Message> Freeze for Input<'a, Message>
where Option<Box<dyn Fn(String) -> Message + 'a>>: Freeze, Option<Message>: Freeze,

§

impl<'a, Message> Unpin for Input<'a, Message>
where Option<Box<dyn Fn(String) -> Message + 'a>>: Unpin, Option<Message>: Unpin,

§

impl<'a, Message> UnsafeUnpin for Input<'a, Message>
where Option<Box<dyn Fn(String) -> Message + 'a>>: UnsafeUnpin, Option<Message>: UnsafeUnpin,

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more