Struct ComponentSignature

#[non_exhaustive]
pub struct ComponentSignature {
    pub name: Option<String>,
    pub format: ComponentVersion,
    pub metadata: ComponentMetadata,
    pub wellknown: Vec<WellKnownSchema>,
    pub types: Vec<TypeDefinition>,
    pub operations: Vec<OperationSignature>,
    pub config: Vec<Field>,
}

Signature for Collections.

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: Option<String>

Name of the collection.

format: ComponentVersion

The format of the component signature.

metadata: ComponentMetadata

Component implementation version.

wellknown: Vec<WellKnownSchema>

A map of type signatures referenced elsewhere.

types: Vec<TypeDefinition>

A map of type signatures referenced elsewhere.

operations: Vec<OperationSignature>

A list of OperationSignatures in this component.

config: Vec<Field>

The component’s configuration for this implementation.

Implementations

impl ComponentSignature

pub fn new<T: Into<String>>( name: T, version: Option<String>, operations: Vec<OperationSignature>, types: Vec<TypeDefinition>, config: Vec<Field>, ) -> Self

Create a new ComponentSignature with the passed name.

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

Create a new ComponentSignature with the passed name.

pub fn get_operation(&self, operation_name: &str) -> Option<&OperationSignature>

Get the OperationSignature for the requested component.

pub fn add_operation(self, signature: OperationSignature) -> Self

Add a OperationSignature to the collection.

pub fn set_version<T: Into<String>>(self, version: T) -> Self

Set the version of the ComponentSignature.

pub const fn format(self, format: ComponentVersion) -> Self

Set the format of the ComponentSignature.

pub fn metadata(self, features: ComponentMetadata) -> Self

Set the features of the ComponentSignature.

Trait Implementations

impl Clone for ComponentSignature

fn clone(&self) -> ComponentSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentSignature

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

Formats the value using the given formatter.

impl Default for ComponentSignature

fn default() -> ComponentSignature

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ComponentSignature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ComponentSignature

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ComponentSignature

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 ComponentSignature