Skip to main content

TuiPagesBuilder

Struct TuiPagesBuilder 

Source
pub struct TuiPagesBuilder<V, A, S, O = (), M = (), Pages = (), Handler = ()> { /* private fields */ }

Implementations§

Source§

impl<V, A, S, O, M> TuiPagesBuilder<V, A, S, O, M, (), ()>

Source

pub fn new(initial_view: V) -> Self

Source§

impl<V, A, S, O, M, Pages, Handler> TuiPagesBuilder<V, A, S, O, M, Pages, Handler>

Source

pub fn fallback_view(self, fallback_view: V) -> Self

Source

pub fn input_timeout_ms(self, timeout_ms: u64) -> Self

Source

pub fn command_timeout_ms(self, timeout_ms: u64) -> Self

Source

pub fn pages<NextPages>( self, pages: NextPages, ) -> TuiPagesBuilder<V, A, S, O, M, NextPages, Handler>

Source

pub fn page_fn( self, page_fn: PageFn<V, S, O>, ) -> TuiPagesBuilder<V, A, S, O, M, PageFn<V, S, O>, Handler>

Set the page provider to a plain fn, coercing it to PageFn at the call site so the application never writes page_spec as PageFn<…>.

.pages(f) keeps the fn item type, which a type App = TuiPages<…> alias cannot name; this method pins the PageFn pointer type the alias uses, so .page_fn(page_spec) just works:

TuiPages::builder(View::Home).page_fn(page_spec).handler(Handler).build()
Source

pub fn handler<NextHandler>( self, handler: NextHandler, ) -> TuiPagesBuilder<V, A, S, O, M, Pages, NextHandler>

Source

pub fn focus_wrap(self, wrap: FocusWrap) -> Self

Set how focus navigation behaves at the ends of a list — clamp (default) or wrap-around. Applies to page focus and modal items.

Source

pub fn keymap( self, mode: impl Into<ModeId>, configure: impl FnOnce(&mut KeyMap<A>), ) -> Self

Source

pub fn bind(self, mode: impl Into<ModeId>, binding: &str, action: A) -> Self

Source

pub fn command<I, Alias>( self, action_name: impl Into<String>, aliases: I, action: A, ) -> Self
where A: Clone, I: IntoIterator<Item = Alias>, Alias: Into<String>,

Source

pub fn build(self) -> TuiPages<V, A, S, Pages, Handler, O, M>
where V: Clone + PartialEq, Pages: PageProvider<V, S, O>, Handler: TuiActionHandler<V, A, S, O, M>,

Trait Implementations§

Source§

impl<V: Clone, A: Clone, S: Clone, O: Clone, M: Clone, Pages: Clone, Handler: Clone> Clone for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>

Source§

fn clone(&self) -> TuiPagesBuilder<V, A, S, O, M, Pages, Handler>

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<V: Debug, A: Debug, S: Debug, O: Debug, M: Debug, Pages: Debug, Handler: Debug> Debug for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<V, A, S, O, M, Pages, Handler> Freeze for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>
where V: Freeze, Pages: Freeze, Handler: Freeze,

§

impl<V, A, S, O, M, Pages, Handler> RefUnwindSafe for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>

§

impl<V, A, S, O, M, Pages, Handler> Send for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>
where V: Send, Pages: Send, Handler: Send, S: Send, O: Send, M: Send, A: Send,

§

impl<V, A, S, O, M, Pages, Handler> Sync for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>
where V: Sync, Pages: Sync, Handler: Sync, S: Sync, O: Sync, M: Sync, A: Sync,

§

impl<V, A, S, O, M, Pages, Handler> Unpin for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>
where V: Unpin, Pages: Unpin, Handler: Unpin, S: Unpin, O: Unpin, M: Unpin, A: Unpin,

§

impl<V, A, S, O, M, Pages, Handler> UnsafeUnpin for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>
where V: UnsafeUnpin, Pages: UnsafeUnpin, Handler: UnsafeUnpin,

§

impl<V, A, S, O, M, Pages, Handler> UnwindSafe for TuiPagesBuilder<V, A, S, O, M, Pages, Handler>
where V: UnwindSafe, Pages: UnwindSafe, Handler: UnwindSafe, S: UnwindSafe, O: UnwindSafe, M: UnwindSafe, A: 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<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