wick-component 0.17.0

Macros and exports used to create Wick components
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

use wick_packet::{OutputIterator, Port};

/// Trait for operation outputs to handle situations where packets need to be sent to all output streams.
pub trait Broadcast {
  /// Broadcast an open bracket to all output streams.
  fn broadcast_open(&mut self) {
    for output in self.outputs_mut() {
      output.open_bracket();
    }
  }

  /// Broadcast a close bracket to all output streams.
  fn broadcast_close(&mut self) {
    for output in self.outputs_mut() {
      output.close_bracket();
    }
  }

  /// Broadcast a done signal to all output streams.
  fn broadcast_done(&mut self) {
    for output in self.outputs_mut() {
      output.done();
    }
  }

  /// Broadcast an error to all output streams.
  fn broadcast_err(&mut self, err: impl Into<String>) {
    let err = err.into();
    for output in self.outputs_mut() {
      output.error(&err);
    }
  }

  /// Get all output streams.
  fn outputs_mut(&mut self) -> OutputIterator<'_>;
}

/// Trait implemented for output sets with a single output port.
pub trait SingleOutput: Broadcast {
  /// The single output port.
  fn single_output(&mut self) -> &mut dyn Port;
}

impl<T: Port> Broadcast for T {
  fn outputs_mut(&mut self) -> OutputIterator<'_> {
    OutputIterator::new(vec![self])
  }
}