sketchbook 0.0.2

Interactive visual applications 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

//! Built-in reams to run sketches.
//!
//! A ream runs sketches inside an environment.

#[cfg(feature = "ream-single")]
mod single;

#[cfg(feature = "ream-parallel")]
mod parallel;

#[cfg(feature = "ream-concurrent")]
mod concurrent;

#[cfg(feature = "ream-parallel")]
pub use parallel::*;

#[cfg(feature = "ream-single")]
pub use single::*;

#[cfg(feature = "ream-concurrent")]
pub use concurrent::*;

use crate::env::*;

/// Trait for reams.
///
/// A ream runs one or more sketches in the context of an environment.
pub trait Ream {
    /// Environment ream will run in.
    type Env: Environment;

    /// Error the ream can return.
    type Error;

    /// Update all sketches managed by the ream.
    ///
    /// The `mill` is used to create new pages from the environment.
    fn update(&mut self, mill: &mut MillOf<Self::Env>) -> Result<Status, Self::Error>;
}