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
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
81
82

//! Environment for sketches to run in.

#[cfg(feature = "env-minimal")]
#[cfg_attr(docsrs, doc(cfg(feature = "env-minimal")))]
pub mod minimal;

mod single_aspect;

/// Trait for environment page.
///
/// A page is the local context of the environment for a sketch.
/// This allows the sketch to interact with the environment directly.
/// Additionally, the environment can push events to the sketch for it to handle.
pub trait Page {
    /// Events generated by this page.
    type Event;

    /// Signals the ream is starting processing events for this page.
    ///
    /// The page should use this signal to limit the events returned by `next_event_in_group` to
    /// those already queued since the last group started.
    fn start_group(&mut self);

    /// Signals the ream has stopped processing events for this page.
    fn end_group(&mut self);

    /// Get the next event in this group of events if there is one.
    fn next_event_in_group(&mut self) -> Option<Self::Event>;

    /// Process an event before it is passed to the sketch to handle.
    fn before_event(&mut self, event: &Self::Event);

    /// Process an event after it is passed to the sketch.
    fn finish_event(&mut self, event: Self::Event);

    /// Status of the sketch/page so the ream knows to continue or stop execution.
    fn status(&self) -> Status;
}

/// Factory for creating pages from an environment.
pub trait Mill {
    /// Type of page this mill creates.
    type Page: Page;

    /// Create a new page connected to the environment.
    fn new_page(&mut self) -> Self::Page;
}

/// Status flag
#[derive(PartialEq, Eq, Debug)]
pub enum Status {
    /// Operation should continue
    Continue,

    /// Operation should be stopped
    Stop,
}

/// Environment for sketches to run in and interact with.
pub trait Environment {
    /// Mill for environment to create pages from.
    type Mill: Mill;

    /// Return type from running the environment.
    type Return;

    /// Run environment with callback function.
    ///
    /// The callback function should be a ream `.update()` function in a `move` closure.
    fn run<F, E>(self, func: F) -> Self::Return
    where
        F: FnMut(&mut Self::Mill) -> Result<Status, E>;
}

/// Helper to get `Mill` of type implementing the `Environment` trait.
pub type MillOf<T> = <T as Environment>::Mill;

/// Helper to get `Page` of type implementing the `Environment` trait.
pub type PageOf<T> = <MillOf<T> as Mill>::Page;

/// Helper to get `Event` of type implementing the `Environment` trait.
pub type EventOf<T> = <PageOf<T> as Page>::Event;