wick-interface-types 0.17.0

Types used by 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
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
83
84
85
86
87
88
89
90

use serde::{Deserialize, Serialize};

use crate::{contents_equal, Field, Type};

/// The signature of a Wick component, including its input and output types.
#[derive(Debug, Clone, Default, Serialize, Deserialize, Eq)]
#[must_use]
#[non_exhaustive]
pub struct OperationSignature {
  /// The name of the component.
  #[serde(default)]
  pub name: String,

  /// The operation's configuration.
  #[serde(default, skip_serializing_if = "Vec::is_empty")]
  pub config: Vec<Field>,

  /// The component's inputs.
  #[serde(default)]
  #[serde(skip_serializing_if = "Vec::is_empty")]
  pub inputs: Vec<Field>,

  /// The component's outputs.
  #[serde(default)]
  #[serde(skip_serializing_if = "Vec::is_empty")]
  pub outputs: Vec<Field>,
}

impl PartialEq for OperationSignature {
  fn eq(&self, other: &Self) -> bool {
    self.name == other.name
      && contents_equal(&self.inputs, &other.inputs)
      && contents_equal(&self.outputs, &other.outputs)
  }
}

impl OperationSignature {
  pub fn new<T: Into<String>>(name: T, inputs: Vec<Field>, outputs: Vec<Field>, config: Vec<Field>) -> Self {
    Self {
      name: name.into(),
      config,
      inputs,
      outputs,
    }
  }

  /// Get the name of the operation.
  #[must_use]
  pub fn name(&self) -> &str {
    &self.name
  }

  /// Get the operation's configuration.
  #[must_use]
  pub fn config(&self) -> &[Field] {
    &self.config
  }

  /// Get the operation's inputs.
  #[must_use]
  pub fn inputs(&self) -> &[Field] {
    &self.inputs
  }

  /// Get the operation's outputs.
  #[must_use]
  pub fn outputs(&self) -> &[Field] {
    &self.outputs
  }

  /// Create a new [OperationSignature] with the passed name.
  pub fn new_named<T: Into<String>>(name: T) -> Self {
    Self {
      name: name.into(),
      ..Default::default()
    }
  }

  /// Add an input port.
  pub fn add_input<T: Into<String>>(mut self, name: T, ty: Type) -> Self {
    self.inputs.push(Field::new(name, ty));
    self
  }

  /// Add an input port.
  pub fn add_output<T: Into<String>>(mut self, name: T, ty: Type) -> Self {
    self.outputs.push(Field::new(name, ty));
    self
  }
}