Skip to main content

Theme

pub struct Theme { /* private fields */ }
Expand description

Output theme controlling symbols and formatting

A theme defines the visual appearance of user-facing messages through configurable symbols. Themes enable consistent styling across all output and support different environments (terminals, CI/CD, accessibility needs).

§Predefined Themes

  • Emoji (default): Unicode emoji symbols for interactive terminals
  • Plain: Text labels like [INFO], [OK] for CI/CD environments
  • ASCII: Basic ASCII characters for limited terminal support

§Examples

use torrust_tracker_deployer_lib::presentation::cli::views::Theme;

// Use emoji theme (default)
let theme = Theme::emoji();
assert_eq!(theme.progress_symbol(), "⏳");

// Use plain text theme for CI/CD
let theme = Theme::plain();
assert_eq!(theme.success_symbol(), "[OK]");

// Use ASCII theme for limited terminals
let theme = Theme::ascii();
assert_eq!(theme.error_symbol(), "[x]");

Implementations§

Source§

impl Theme

Source

pub fn emoji() -> Self

Create emoji theme with Unicode symbols (default)

Best for interactive terminals with good Unicode support. Uses emoji characters that are visually distinctive and widely supported.

§Examples
use torrust_tracker_deployer_lib::presentation::cli::views::Theme;

let theme = Theme::emoji();
assert_eq!(theme.progress_symbol(), "⏳");
assert_eq!(theme.success_symbol(), "✅");
assert_eq!(theme.warning_symbol(), "⚠️");
assert_eq!(theme.error_symbol(), "❌");
Source

pub fn plain() -> Self

Create plain text theme for CI/CD environments

Uses text labels like [INFO], [OK], [WARN], [ERROR] that work in any environment without Unicode support. Ideal for CI/CD pipelines and log aggregation systems.

§Examples
use torrust_tracker_deployer_lib::presentation::cli::views::Theme;

let theme = Theme::plain();
assert_eq!(theme.progress_symbol(), "[INFO]");
assert_eq!(theme.success_symbol(), "[OK]");
assert_eq!(theme.warning_symbol(), "[WARN]");
assert_eq!(theme.error_symbol(), "[ERROR]");
Source

pub fn ascii() -> Self

Create ASCII-only theme using basic characters

Uses simple ASCII characters that work on any terminal. Good for environments with limited character set support or when maximum compatibility is required.

§Examples
use torrust_tracker_deployer_lib::presentation::cli::views::Theme;

let theme = Theme::ascii();
assert_eq!(theme.progress_symbol(), "=>");
assert_eq!(theme.success_symbol(), "[+]");
assert_eq!(theme.warning_symbol(), "[!]");
assert_eq!(theme.error_symbol(), "[x]");
Source

pub fn progress_symbol(&self) -> &str

Get the progress symbol for this theme

Source

pub fn success_symbol(&self) -> &str

Get the success symbol for this theme

Source

pub fn warning_symbol(&self) -> &str

Get the warning symbol for this theme

Source

pub fn error_symbol(&self) -> &str

Get the error symbol for this theme

Source

pub fn detail_symbol(&self) -> &str

Get the detail symbol for this theme (verbose progress)

Source

pub fn debug_symbol(&self) -> &str

Get the debug symbol for this theme (debug-level details)

Trait Implementations§

Source§

impl Clone for Theme

Source§

fn clone(&self) -> Self

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

Source§

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

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

impl Default for Theme

Source§

fn default() -> Self

Create the default theme (emoji)

§Examples
use torrust_tracker_deployer_lib::presentation::cli::views::Theme;

let theme = Theme::default();
assert_eq!(theme.progress_symbol(), "⏳");
Source§

impl Eq for Theme

Source§

impl PartialEq for Theme

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Theme

Auto Trait Implementations§

§

impl Freeze for Theme

§

impl RefUnwindSafe for Theme

§

impl Send for Theme

§

impl Sync for Theme

§

impl Unpin for Theme

§

impl UnsafeUnpin for Theme

§

impl UnwindSafe for Theme

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

Source§

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

Checks if this value is equivalent to the given key. 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = !

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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