ColorfulVersion

Struct ColorfulVersion 

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

Configuration for colorful version output

Implementations§

Source§

impl ColorfulVersion

Source

pub fn from_cargo() -> Self

Creates a new ColorfulVersion using values from Cargo.toml

Source

pub fn new( package_name: &'static str, version: &'static str, author: &'static str, ) -> Self

Creates a new ColorfulVersion with custom values

Source

pub fn with_hex_colors( self, name_fg: &str, name_bg: &str, version: &str, author: &str, ) -> Result<Self, VersionError>

Sets custom hex colors for the version output

§Arguments
  • name_fg - Hex color for package name foreground (e.g., “#FFFFFF”)
  • name_bg - Hex color for package name background (e.g., “#AA00FF”)
  • version - Hex color for version text (e.g., “#FFFF00”)
  • author - Hex color for author text (e.g., “#00FFFF”)
§Errors

Returns VersionError::InvalidHexColor if any hex color is invalid

Source

pub fn with_rgb_colors( self, name_fg: (u8, u8, u8), name_bg: (u8, u8, u8), version: (u8, u8, u8), author: (u8, u8, u8), ) -> Self

Sets custom RGB colors for the version output

Source

pub fn print_and_exit(&self) -> !

Prints the colorful version to stdout and exits the process

Source

pub fn print(&self)

Prints the colorful version to stdout Format: “{package_name} v{version} by {author}”

Source

pub fn to_string(&self) -> String

Returns a plain text version string (for clap’s version flag) Format: “{package_name} v{version} by {author}”

Source

pub fn to_colored_string(&self) -> String

Returns a colored version string if terminal supports colors Format: “{package_name} v{version} by {author}”

Source

pub fn check_and_exit(&self, matches: &ArgMatches)

Checks if the version flag was used and handles it

This method should be called after parsing command-line arguments. If the version flag is found, it prints the colorful version and exits.

Source

pub fn package_name(&self) -> &str

Returns the package name

Source

pub fn version(&self) -> &str

Returns the version

Source

pub fn author(&self) -> &str

Returns the author

Trait Implementations§

Source§

impl Clone for ColorfulVersion

Source§

fn clone(&self) -> ColorfulVersion

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 ColorfulVersion

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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