blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve formatting for color parsing docs (#496)

Browse Source
This commit is contained in:
Max Sharnoff 2020-10-10 08:32:18 +01:00 committed by GitHub
parent 6730e4050a
commit efb06b8baa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/style/ansi.rs
View File

@ -90,13 +90,14 @@ impl Colored {
/// This is the string that would appear within an `ESC [ <str> m` escape sequence, as found in /// This is the string that would appear within an `ESC [ <str> m` escape sequence, as found in
/// various configuration files. /// various configuration files.
/// ///
/// For example: `38;5;0 -> ForegroundColor(Black)`, /// For example:
/// `38;5;26 -> ForegroundColor(AnsiValue(26))` /// * `38;5;0 -> ForegroundColor(Black)`,
/// `48;2;50;60;70 -> BackgroundColor(Rgb(50, 60, 70))` /// * `38;5;26 -> ForegroundColor(AnsiValue(26))`
/// `49 -> BackgroundColor(Reset)` /// * `48;2;50;60;70 -> BackgroundColor(Rgb(50, 60, 70))`
/// Invalid sequences map to None. /// * `49 -> BackgroundColor(Reset)`
/// Invalid sequences map to `None`.
/// ///
/// Currently, 3/4 bit color values aren't supported so return None. /// Currently, 3/4 bit color values aren't supported so return `None`.
/// ///
/// See also: [Color::parse_ansi](enum.Color.html#method.parse_ansi) /// See also: [Color::parse_ansi](enum.Color.html#method.parse_ansi)
pub fn parse_ansi(ansi: &str) -> Option<Self> { pub fn parse_ansi(ansi: &str) -> Option<Self> {
@ -124,10 +125,13 @@ impl Colored {
impl<'a> Color { impl<'a> Color {
/// Parses an ANSI color sequence. /// Parses an ANSI color sequence.
/// For example: `5;0 -> Black`, `5;26 -> AnsiValue(26)`, `2;50;60;70 -> Rgb(50, 60, 70)`. /// For example:
/// Invalid sequences map to None. /// * `5;0 -> Black`,
/// * `5;26 -> AnsiValue(26)`,
/// * `2;50;60;70 -> Rgb(50, 60, 70)`.
/// Invalid sequences map to `None`.
/// ///
/// Currently, 3/4 bit color values aren't supported so return None. /// Currently, 3/4 bit color values aren't supported so return `None`.
/// ///
/// See also: [Colored::parse_ansi](enum.Colored.html#method.parse_ansi) /// See also: [Colored::parse_ansi](enum.Colored.html#method.parse_ansi)
pub fn parse_ansi(ansi: &str) -> Option<Self> { pub fn parse_ansi(ansi: &str) -> Option<Self> {