Skip to main content

Ui

Struct Ui 

Source
pub struct Ui { /* private fields */ }

Implementations§

Source§

impl Ui

Source

pub fn new() -> Self

Source

pub fn with_config(config: Config) -> Self

Source

pub fn cached_with_config(config: Config, envelope_mode: EnvelopeMode) -> Self

Returns a cached Ui instance configured with the given config and envelope mode. The cache is per-thread and keyed by config. If the same config is requested, the cached instance is returned, avoiding repeated creation.

Source

pub fn config(&self) -> &Config

Get reference to the current configuration.

Source

pub fn use_color(&self) -> bool

Source

pub fn envelope(&self) -> &EnvelopeConfig

Get reference to the current envelope configuration.

Source

pub fn with_envelope(self, config: EnvelopeConfig) -> Self

Source

pub fn with_envelope_mode(self, mode: EnvelopeMode) -> Self

Source

pub fn with_envelope_layout(self, layout: EnvelopeLayout) -> Self

Source

pub fn with_envelope_fields(self, fields: EnvelopeFields) -> Self

Source

pub fn with_prompt_theme(self, theme: PromptTheme) -> Self

Source

pub fn prompt_theme(&self) -> &PromptTheme

Source

pub fn with_format(self, format: Format) -> Self

Source

pub fn interactive(self, value: bool) -> Self

Source

pub fn auto_yes(self, value: bool) -> Self

Source

pub fn logger(&self) -> Logger<'_>

Source

pub fn new_output_content(&self) -> Output

Source

pub fn new_output_meta(&self) -> Meta

Source

pub fn render(&self, output: &Output) -> UiResult<String>

Source

pub fn print(&self, output: &Output) -> UiResult<()>

Source

pub fn print_with_meta( &self, output: &Output, meta: Option<&Meta>, ok: bool, ) -> UiResult<()>

Source

pub fn git_diff(&self, diff: &str) -> String

Trait Implementations§

Source§

impl Clone for Ui

Source§

fn clone(&self) -> Ui

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 Debug for Ui

Source§

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

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

impl Default for Ui

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl LoggerTrait for Ui

Source§

fn heading(&self, msg: &str)

Source§

fn info(&self, msg: &str)

Source§

fn warn(&self, msg: &str)

Source§

fn error(&self, msg: &str)

Source§

fn error_kv(&self, key: &str, value: &str)

Source§

fn debug(&self, msg: &str)

Source§

fn trace(&self, msg: &str)

Source§

fn kv(&self, key: &str, value: &str)

Source§

impl PromptTrait for Ui

Source§

fn text( &self, message: &str, default: Option<&str>, help: Option<&str>, ) -> UiResult<String>

Source§

fn confirm(&self, message: &str, default: bool) -> UiResult<bool>

Source§

fn select(&self, request: &SelectRequest) -> UiResult<String>

Source§

fn multiselect(&self, request: &MultiSelectRequest) -> UiResult<Vec<String>>

Auto Trait Implementations§

§

impl Freeze for Ui

§

impl RefUnwindSafe for Ui

§

impl Send for Ui

§

impl Sync for Ui

§

impl Unpin for Ui

§

impl UnsafeUnpin for Ui

§

impl UnwindSafe for Ui

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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