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

use serde::{Deserialize, Serialize};

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

/// Signatures of struct-like type definitions.
#[derive(Debug, Clone, Default, Serialize, Deserialize, Eq)]
#[must_use]
#[non_exhaustive]
pub struct StructDefinition {
  /// The name of the struct.
  pub name: String,
  /// The fields in this struct.
  #[serde(default, skip_serializing_if = "Vec::is_empty")]
  pub fields: Vec<Field>,
  /// The optional description of the struct.
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub description: Option<String>,
  /// Whether this type is imported.
  #[serde(default, skip_serializing_if = "is_false")]
  pub imported: bool,
}

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

impl StructDefinition {
  /// Constructor for [StructDefinition]
  pub fn new<T: Into<String>>(name: T, fields: Vec<Field>, description: Option<String>) -> Self {
    Self {
      name: name.into(),
      fields,
      imported: false,
      description,
    }
  }
}