Skip to main content

TextInput

Struct TextInput 

Source
pub struct TextInput<'a> {
    pub title: &'a str,
    pub message: &'a str,
    pub value: &'a str,
    pub mode: TextInputMode,
    pub owner: Option<&'a dyn HasWindowHandle>,
}
Expand description

Text input dialog.

The text input dialog allows the user to enter text, which is returned as a string.

Fields§

§title: &'a str

The title of the dialog.

§message: &'a str

The message to display to the user.

§value: &'a str

The initial value to display in the text input.

§mode: TextInputMode

The mode of the text input, which determines the type of dialog shown and how the input is handled.

§owner: Option<&'a dyn HasWindowHandle>

The owner window of the dialog.

Implementations§

Source§

impl<'a> TextInput<'a>

Source

pub fn show(&self) -> Option<String>

Show the dialog.

Returns Some(String) if the user provided input and confirmed the dialog, or None if the user cancelled the dialog.

Examples found in repository?
examples/text_input.rs (line 16)
1fn main() {
2	let mode = match std::process::id() / 4 % 3 {
3		0 => rustydialogs::TextInputMode::SingleLine,
4		1 => rustydialogs::TextInputMode::MultiLine,
5		_ => rustydialogs::TextInputMode::Password,
6	};
7
8	let input = rustydialogs::TextInput {
9		title: "TextInput",
10		message: "Enter some text:",
11		value: "default value",
12		mode,
13		owner: None,
14	};
15
16	match input.show() {
17		Some(value) => println!("TextInput: {value}"),
18		None => println!("Canceled"),
19	}
20}

Trait Implementations§

Source§

impl<'a> Clone for TextInput<'a>

Source§

fn clone(&self) -> TextInput<'a>

Returns a duplicate 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<'a> Copy for TextInput<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for TextInput<'a>

§

impl<'a> !RefUnwindSafe for TextInput<'a>

§

impl<'a> !Send for TextInput<'a>

§

impl<'a> !Sync for TextInput<'a>

§

impl<'a> Unpin for TextInput<'a>

§

impl<'a> UnsafeUnpin for TextInput<'a>

§

impl<'a> !UnwindSafe for TextInput<'a>

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

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

Source§

type Error = Infallible

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

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

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.