3 releases

new 0.1.2 Mar 23, 2020
0.1.1 Feb 12, 2018
0.1.0 Aug 18, 2017

#58 in Text processing

Download history 563/week @ 2019-12-02 535/week @ 2019-12-09 635/week @ 2019-12-16 390/week @ 2019-12-23 417/week @ 2019-12-30 468/week @ 2020-01-06 429/week @ 2020-01-13 494/week @ 2020-01-20 400/week @ 2020-01-27 753/week @ 2020-02-03 524/week @ 2020-02-10 468/week @ 2020-02-17 458/week @ 2020-02-24 422/week @ 2020-03-02 426/week @ 2020-03-09 350/week @ 2020-03-16

1,993 downloads per month
Used in 7 crates (5 directly)

MIT/Apache

14KB
150 lines

Ferris Says

A library for printing out text with Ferris as the mascot!

Build requirements

You only need a stable version of the Rust compiler. Due to the use of the ? operator only versions 1.15 and up of rustc are supported.

How to use the library

Put the following in your Cargo.toml:

[dependencies]
ferris-says = "0.1"

Then import the crate with:

extern crate ferris_says;

Example

The following bit of code will write the byte string to STDOUT

extern crate ferris_says;

use ferris_says::say;
use std::io::{ stdout, BufWriter };

fn main() {
    let out = b"Hello fellow Rustaceans!";
    let width = 24;

    let mut writer = BufWriter::new(stdout());
    say(out, width, &mut writer).unwrap();
}

This will print out this when run:

----------------------------
| Hello fellow Rustaceans! |
----------------------------
              \
               \
                 _~^~^~_
             \) /  o o  \ (/
               '_   -   _'
               / '-----' \

How to use the binary

The binary version is called fsays. It reads input from stdin and prints it out to the console.

echo 'Hello fellow Rustaceans!' | fsays --width 24

This will print out this when run:

----------------------------
| Hello fellow Rustaceans! |
----------------------------
              \
               \
                 _~^~^~_
             \) /  o o  \ (/
               '_   -   _'
               / '-----' \

You can also use multiple files as input by using the -f/--files flag!

Contributing

See CONTRIBUTING.md for more information.

License

Licensed under either of

at your option.

Licensing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Credit

Original Ferris ASCII art by @Diggsey

Dependencies

~1MB
~20K SLoC