Skip to main content

Form

Struct Form 

Source
pub struct Form { /* private fields */ }
Expand description

A blocking, ordered collection of prompt groups.

Implementations§

Source§

impl Form

Source

pub fn builder() -> FormBuilder

Starts building a form.

Source

pub fn run(self, theme: &Theme) -> Result<FormOutcome, RunError>

Runs this form on the process’s interactive terminal connection.

The supplied theme and detected terminal capabilities are resolved once into the prompt’s styles, and fields build their view from those resolved values; no component role reaches the renderer. This convenience path opens the process’s default interactive terminal. It does not query the terminal background or change the supplied theme.

Source

pub fn run_with_terminal( self, terminal: &mut impl TerminalBackend, theme: &Theme, ) -> Result<FormOutcome, RunError>

Runs this form on a caller-owned interactive terminal connection.

The same backend supplies terminal queries, input events, and rendered output for the complete prompt session. This method queries its size and rendering capabilities, but never queries its background and never changes the supplied theme. A caller selecting a theme with urushi::ThemeMode::Auto should query the background first and then pass that same backend here.

Auto Trait Implementations§

§

impl Freeze for Form

§

impl !RefUnwindSafe for Form

§

impl !Send for Form

§

impl !Sync for Form

§

impl Unpin for Form

§

impl UnsafeUnpin for Form

§

impl !UnwindSafe for Form

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> 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, 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.