Struct Colors

pub struct Colors<W> { /* private fields */ }

Colors writable type characters with the ascii rainbow

You can use this any type that requires a io::Write type

examples

Write direcly to stdout

use std::io::{self, Write};
write!(
  &mut rainbowcoat::Colors::new(io::stdout()),
  "hello rainbow"
);

A convenience function makes this common case even easier

use std::io::Write;
write!(
  &mut rainbowcoat::stdout(),
  "hello rainbow"
);

Implementations

impl<W> Colors<W>

pub fn new(wrapped: W) -> Self

Creates a new Colors instance with default spread of 3.0, frequency of 0.1 and seed valud of 0.0

pub fn configure(wrapped: W, spread: f64, frequency: f64, seed: f64) -> Self

Creates a more configurable instance with provided params

Examples found in repository

examples/coat.rs (line 6)

fn run() -> io::Result<()> {
    write!(
        &mut rainbowcoat::Colors::configure(io::stdout(), 2.0, 0.4, 0.0),
        r"                  _
                 ( |
                   |
            __,--./|.--,__
          .`   \ \ / /    `.
        .`      \ | /       `.
       /   /     ^|^      \   \
      /   / |     |o     | \   \
     /===/  |     |      |  \===\
    /___/   |     |o     |   \___\
            |     |      |
            |     |o     |
            |     |      |
            |     |o     |
            |     |      |
            |     |o     |
            |_____/\_____|
"
    )?;
    Ok(())
}

Trait Implementations

impl<W: Write> Write for Colors<W>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.