Skip to main content

DialogData

Struct DialogData 

Source
pub struct DialogData<D = ()> {
    pub title: String,
    pub message: String,
    pub buttons: Vec<String>,
    pub purpose: Option<D>,
    pub is_loading: bool,
}
Expand description

The content of a modal dialog.

D is an application-owned “purpose” payload (often an enum) that the app uses to tell apart which dialog was answered. It is opaque to the library.

DialogData is stored as the focus manager’s dialog payload via DialogData::show_intent; the focus manager tracks which button is active and navigates between them.

Fields§

§title: String§message: String§buttons: Vec<String>§purpose: Option<D>§is_loading: bool

Implementations§

Source§

impl<D> DialogData<D>

Source

pub fn new( title: impl Into<String>, message: impl Into<String>, buttons: impl IntoIterator<Item = impl Into<String>>, purpose: D, ) -> Self

A dialog with a title, message, selectable buttons, and a purpose used to interpret the selection.

Source

pub fn loading(title: impl Into<String>, message: impl Into<String>) -> Self

A buttonless “please wait” dialog. Replace it with DialogData::new (via show_intent) once the work completes.

Source

pub fn button_count(&self) -> usize

Source§

impl<D> DialogData<D>

Source

pub fn show_intent<O>(self) -> FocusIntent<O, DialogData<D>>

The focus intent that opens this dialog as a modal overlay. Wrap it in TuiEffect::Focus (or apply it directly to a FocusManager). O is the app’s overlay type and is inferred from the surrounding runtime.

Trait Implementations§

Source§

impl<D: Clone> Clone for DialogData<D>

Source§

fn clone(&self) -> DialogData<D>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<D: Debug> Debug for DialogData<D>

Source§

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

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

impl<D: PartialEq> PartialEq for DialogData<D>

Source§

fn eq(&self, other: &DialogData<D>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<D: Eq> Eq for DialogData<D>

Source§

impl<D> StructuralPartialEq for DialogData<D>

Auto Trait Implementations§

§

impl<D> Freeze for DialogData<D>
where D: Freeze,

§

impl<D> RefUnwindSafe for DialogData<D>
where D: RefUnwindSafe,

§

impl<D> Send for DialogData<D>
where D: Send,

§

impl<D> Sync for DialogData<D>
where D: Sync,

§

impl<D> Unpin for DialogData<D>
where D: Unpin,

§

impl<D> UnsafeUnpin for DialogData<D>
where D: UnsafeUnpin,

§

impl<D> UnwindSafe for DialogData<D>
where D: 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,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
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