pub struct ColorfulVersion { /* private fields */ }Expand description
Configuration for colorful version output
Implementations§
Source§impl ColorfulVersion
impl ColorfulVersion
Sourcepub fn from_cargo() -> Self
pub fn from_cargo() -> Self
Creates a new ColorfulVersion using values from Cargo.toml
Sourcepub fn new(
package_name: &'static str,
version: &'static str,
author: &'static str,
) -> Self
pub fn new( package_name: &'static str, version: &'static str, author: &'static str, ) -> Self
Creates a new ColorfulVersion with custom values
Sourcepub fn with_hex_colors(
self,
name_fg: &str,
name_bg: &str,
version: &str,
author: &str,
) -> Result<Self, VersionError>
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
Sourcepub fn with_rgb_colors(
self,
name_fg: (u8, u8, u8),
name_bg: (u8, u8, u8),
version: (u8, u8, u8),
author: (u8, u8, u8),
) -> Self
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
Sourcepub fn print_and_exit(&self) -> !
pub fn print_and_exit(&self) -> !
Prints the colorful version to stdout and exits the process
Sourcepub fn print(&self)
pub fn print(&self)
Prints the colorful version to stdout Format: “{package_name} v{version} by {author}”
Sourcepub fn to_string(&self) -> String
pub fn to_string(&self) -> String
Returns a plain text version string (for clap’s version flag) Format: “{package_name} v{version} by {author}”
Sourcepub fn to_colored_string(&self) -> String
pub fn to_colored_string(&self) -> String
Returns a colored version string if terminal supports colors Format: “{package_name} v{version} by {author}”
Sourcepub fn check_and_exit(&self, matches: &ArgMatches)
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.
Sourcepub fn package_name(&self) -> &str
pub fn package_name(&self) -> &str
Returns the package name
Returns the author
Trait Implementations§
Source§impl Clone for ColorfulVersion
impl Clone for ColorfulVersion
Source§fn clone(&self) -> ColorfulVersion
fn clone(&self) -> ColorfulVersion
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more