[−][src]Enum crossterm::Attribute
Enum with the different attributes to style your test.
There are few things to note:
- Not all attributes are supported, some of them are only supported on Windows some only on Unix, and some are only very rarely supported.
- I got those attributes, descriptions, supportability from here: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters
- Take note of the fact that when running your program cross-platform that some attributes might not work because of their support.
- When an attribute is not supported nothing will happen with the terminal state.
Example
You can use an attribute in a write statement to apply the attribute to the terminal output.
println!( "{} Underlined {} No Underline", Attribute::Underlined, Attribute::NoUnderline );
You can also call attribute functions on a &'static str
:
use Colorizer; println!("{}", style("Bold text").bold()); println!("{}", style("Underlined text").underlined()); println!("{}", style("Negative text").negative());
Variants
All attributes off [info]: This will reset all current set attributes. [Supportability]: Windows, UNIX.
Increased Intensity [info]: This will increase the text sensitivity also known as bold. [Supportability]: Windows, UNIX.
Decreased Intensity [info]: This will decrease the text sensitivity also known as bold. [Supportability]: Windows, UNIX.
Italic Text [info]: This will make the text italic. [Supportability]: Not widely supported, sometimes treated as inverse.
This will draw a line under the text. [info]: An line under a word, especially in order to show its importance. [Supportability]: Windows, UNIX
Slow Blinking Text [info]: Blink Less than 150 per minute. [Supportability]: UNIX
Slow Blinking Text [info]: MS-DOS ANSI.SYS; 150+ per minute; [Supportability]: Not widely supported
Swap foreground and background colors [info]: swap foreground and background colors [Supportability]: Windows, UNIX
Hide text [info]:
- This will make the text hidden.
- Also known as 'Conceal' [Supportability]: Windows, UNIX
Cross-out text [info]: Characters legible, but marked for deletion. [Supportability]: UNIX
The Fraktur is a typeface belonging to the group of Gothic typefaces. [info]: https://nl.wikipedia.org/wiki/Fraktur [Supportability]: Rarely supported
This will turn off the bold attribute. [info]:
- Double-underline per ECMA-48.
- WikiPedia: https://en.wikipedia.org/wiki/Talk:ANSI_escape_code#SGR_21%E2%80%94%60Bold_off%60_not_widely_supported
- Opposite of
Bold
(1) [Supportability]: not widely supported
Normal color or intensity Neither bold nor faint
This will turn off the italic attribute. [info]:
- Not italic, not Fraktur
- Opposite of
Italic
(3) [Supportability]: Windows, UNIX
This will turn off the underline attribute. [info]:
- Not singly or doubly underlined will be turned off.
- Opposite of
Underlined.
(4) [Supportability]: Windows, UNIX
This will turn off the blinking attribute
[info]: Opposite of Slow and Rapid blink.
(5,6)
[Supportability]: Unknown
This will turn off the reverse attribute.
[info]: Opposite of Reverse
(7)
[Supportability]: Windows, unknown
This will make the text visible.
[info]: Opposite of Hidden
(8)
[Supportability]: Unknown
This will turn off the crossed out attribute.
[info]: Opposite of CrossedOut
(9)
[Supportability]: Not widely supported
Framed text. [Supportability]: Not widely supported
This will turn on the encircled attribute.
This will draw a line at the top of the text. [info]: Implementation defined (according to standard) [Supportability]: Unknown
This will turn off the framed or encircled attribute.
This will turn off the overLined attribute.
[info]: Opposite of OverLined
(7)
[Supportability]: Windows, unknown
Trait Implementations
impl PartialOrd<Attribute> for Attribute
[src]
fn partial_cmp(&self, other: &Attribute) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Ord for Attribute
[src]
fn cmp(&self, other: &Attribute) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
1.21.0[src]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl Eq for Attribute
[src]
impl Hash for Attribute
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Debug for Attribute
[src]
impl Clone for Attribute
[src]
impl Copy for Attribute
[src]
impl Display for Attribute
[src]
impl PartialEq<Attribute> for Attribute
[src]
Auto Trait Implementations
impl Send for Attribute
impl Sync for Attribute
impl Unpin for Attribute
impl RefUnwindSafe for Attribute
impl UnwindSafe for Attribute
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,