Struct wick_interface_types::OperationSignature

#[non_exhaustive]
pub struct OperationSignature {
    pub name: String,
    pub config: Vec<Field>,
    pub inputs: Vec<Field>,
    pub outputs: Vec<Field>,
}

The signature of a Wick component, including its input and output types.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the component.

config: Vec<Field>

The operation’s configuration.

inputs: Vec<Field>

The component’s inputs.

outputs: Vec<Field>

The component’s outputs.

Implementations

impl OperationSignature

pub fn new<T: Into<String>>( name: T, inputs: Vec<Field>, outputs: Vec<Field>, config: Vec<Field> ) -> Self

pub fn name(&self) -> &str

Get the name of the operation.

pub fn config(&self) -> &[Field]

Get the operation’s configuration.

pub fn inputs(&self) -> &[Field]

Get the operation’s inputs.

pub fn outputs(&self) -> &[Field]

Get the operation’s outputs.

pub fn new_named<T: Into<String>>(name: T) -> Self

Create a new OperationSignature with the passed name.

pub fn add_input<T: Into<String>>(self, name: T, ty: Type) -> Self

Add an input port.

pub fn add_output<T: Into<String>>(self, name: T, ty: Type) -> Self

Add an input port.

Trait Implementations

impl Clone for OperationSignature

fn clone(&self) -> OperationSignature

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OperationSignature

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OperationSignature

fn default() -> OperationSignature

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OperationSignature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<OperationSignature> for OperationSignature

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OperationSignature

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OperationSignature

impl StructuralEq for OperationSignature