farts 1.1.0

Port of fart.js library in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

use std::future::Future;
use std::io::Cursor;

use rodio::{Decoder, OutputStream, Sink};
use rodio::source::Source;
use rust_embed::RustEmbed;

#[derive(RustEmbed)]
#[folder = "assets/farts/"]
struct FartAssets;

pub mod fart {
    pub type Fart = &'static str;

    pub const TOOT: Fart = "fart1.wav";
    pub const RIPPER: Fart = "fart2.wav";
    pub const PLOP: Fart = "fart3.wav";
    pub const SQUIT: Fart = "fart4.wav";
    pub const RASPBERRY: Fart = "fart5.wav";
    pub const SQUAT: Fart = "fart6.wav";
    pub const TUPPENCE: Fart = "fart7.wav";
    pub const LIFTOFF: Fart = "fart8.wav";
    pub const TRUMPET: Fart = "fart9.wav";
    pub const FIZZLER: Fart = "fart10.wav";
    pub const WINDY: Fart = "fart11.wav";
    pub const EINE: Fart = "fart12.wav";
    pub const FARTCEPTION: Fart = "fart13.wav";
    pub const FARTPOINT1: Fart = "fart14.wav";
}

#[derive(Debug)]
pub enum FartingError {
    IO(std::io::Error),
    DecodingError(rodio::decoder::DecoderError),
    StreamingError(rodio::StreamError),
    PlayingError(rodio::PlayError),
}

/**
Play a fart sound.

###### Arguments:
- `fart` - The fart sound to play.
You can discover the available fart sounds by looking in the `farts::fart` module.

###### Example
``` rust
farts::play(farts::fart::WINDY)
    .unwrap();
```
 */
pub fn play(fart: fart::Fart) -> Result<(), FartingError> {
    let asset = FartAssets::get(fart).unwrap();

    let cursor = Cursor::new(asset.data);
    let source = Decoder::new(cursor)
        .map_err(|e| FartingError::DecodingError(e))?;

    let (_stream, stream_handle) = OutputStream::try_default()
        .map_err(|e| FartingError::StreamingError(e))?;

    let sink = Sink::try_new(&stream_handle)
        .map_err(|e| FartingError::PlayingError(e))?;

    sink.append(source);

    sink.sleep_until_end();

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_works() {
        play(fart::TOOT).unwrap();
    }
}