rust-osdev / ansi_rgb Goto Github PK

View Code? Open in Web Editor NEW

16.0 6.0 5.0 42 KB

Colorful terminal text using ANSI escape sequences

Home Page: https://docs.rs/ansi_rgb/

License: MIT License

Rust 100.00%

ansi-escape-sequences ansi-rgb terminal terminal-graphics

ansi_rgb's Introduction

ansi_rgb

Colorful terminal text using ANSI escape sequences.

Very simple API
3-, 4-, 8-, and 24-bit colors
Colors all the formatting traits
Easy to add your own color types
no_std compliant

Full documentation:

https://docs.rs/ansi_rgb

ansi_rgb's People

Contributors

Stargazers

Watchers

Forkers

hanmertens nathan-fiscaletti nalinplad o-x-e-y

ansi_rgb's Issues

Add other owners to crate

Just use the `rgb` crate

https://crates.io/crates/rgb

It supports no_std. Others are using it. Will make it easier for others to interface with this crate, like if they want to use a color conversion function (#6)

Integrate into `rust-osdev` better

PR the About page

Fix formatting of pointers

use ansi_rgb::{ Background, Foreground, red, green };

fn main() {
    println!("{:p}", "Hello, world!".fg(green()).bg(red()));
}

Support or explain usage in Windows console

In a Windows console you just get garbage like this:

�[48;2;159;114;0m �[0m

Probably need to investigate https://docs.microsoft.com/en-us/windows/console/console-modes

Perhaps this functionality needs to go into another crate (or perhaps someone has already implemented this in another crate)

Package the crate better

Take cues from https://github.com/rust-osdev/x86_64

Documentation
Crate categories
Crate keywords
Fix license in meta

"temporary value dropped while borrowed"

use ansi_rgb::{ Background, Foreground, red, green };

fn main() {
    let foo = "Hello, world!".fg(green()).bg(red());
    println!("{}", foo);
}

Output:

error[E0716]: temporary value dropped while borrowed
 --> src\main.rs:4:15
  |
4 |     let foo = "Hello, world!".fg(green()).bg(red());
  |               ^^^^^^^^^^^^^^^^^^^^^^^^^^^          - temporary value is freed at the end of this statement
  |               |
  |               creates a temporary which is freed while still in use
5 |     println!("{}", foo);
  |                    --- borrow later used here
  |
  = note: consider using a `let` binding to create a longer lived value

Axe `main.rs`

This is a library. Give main.rs the axe

Publish 0.2.0 crate

0.2.0 is ready to be published

Color conversion functions

Can convert from HSV with this:

use ansi_rgb::*;
use num_traits::{ Float, Num };

fn pos_mod<T: Num + Copy>(x: T, modulo: T) -> T {
    (x % modulo + modulo) % modulo
}

fn from_hsv(h: f32, s: f32, v: f32) -> Rgb {
    // https://www.rapidtables.com/convert/color/hsv-to-rgb.html
    let h = pos_mod(h, 360.0);
    let s = pos_mod(s, 1.0 + f32::epsilon());
    let v = pos_mod(v, 1.0 + f32::epsilon());
    let c = v * s;
    let x = c * (1.0 - ((h / 60.0) % 2.0 - 1.0).abs());
    let m = v - c;
    let (r, g, b) = match h {
        h if h < 60.0 => (c, x, 0.0),
        h if h < 120.0 => (x, c, 0.0),
        h if h < 180.0 => (0.0, c, x),
        h if h < 240.0 => (0.0, x, c),
        h if h < 300.0 => (x, 0.0, c),
        _ => (c, 0.0, x)
    };
    Rgb::new(
        ((r + m) * 255.0) as u8,
        ((g + m) * 255.0) as u8,
        ((b + m) * 255.0) as u8
    )
}