Struct OperationSpec 

pub struct OperationSpec { /* private fields */ }

Product-neutral catalog record for one operation.

Implementations

impl OperationSpec

pub fn new( name: OperationName, target_kind: TargetKind, access: AccessClass, ) -> Self

Creates a minimal version-one specification.

pub fn with_schema_version(self, schema_version: u32) -> Self

Sets the serialized contract version.

pub fn with_schema_ids( self, parameter_schema: SchemaId, result_schema: SchemaId, ) -> Self

Sets explicit parameter and result schema identities.

pub fn with_diagnostic_code(self, code: DiagnosticCode) -> Self

Declares a stable diagnostic code that the operation may emit.

pub fn with_safety(self, risk: RiskClass, reversibility: Reversibility) -> Self

Sets risk and reversibility metadata.

pub fn with_required(self, required: ParameterGroup) -> Self

Sets fields required for every request.

pub fn with_required_any(self, group: ParameterGroup) -> Self

Adds an alternative complete parameter group.

pub fn with_lifecycle( self, planning: CapabilitySupport, progress: CapabilitySupport, cancellation: CapabilitySupport, verification: CapabilitySupport, fanout: CapabilitySupport, ) -> Self

Sets lifecycle and fanout capability support.

pub fn with_retry(self, retry: RetryClass, idempotent: bool) -> Self

Sets retry behavior and whether mutations are idempotent.

pub fn with_evidence(self, evidence: EvidenceKind) -> Self

Adds an evidence kind returned by the operation.

pub fn with_requirement( self, requirement: impl Into<String>, ) -> Result<Self, SpecError>

Adds an implementation capability requirement such as transport.ssh.

pub fn validate(&self) -> Result<(), SpecError>

Validates cross-field safety and compatibility invariants.

pub fn name(&self) -> &OperationName

Returns the canonical operation name.

pub const fn schema_version(&self) -> u32

Returns the contract schema version.

pub fn parameter_schema(&self) -> &SchemaId

Returns the versioned parameter schema identity.

pub fn result_schema(&self) -> &SchemaId

Returns the versioned result schema identity.

pub fn diagnostic_codes(&self) -> impl Iterator<Item = &DiagnosticCode>

Iterates over stable diagnostic codes declared by the operation.

pub fn allows_diagnostic(&self, code: &DiagnosticCode) -> bool

Returns whether the operation contract declares this diagnostic code.

pub fn target_kind(&self) -> &TargetKind

Returns the required target kind.

pub const fn access(&self) -> AccessClass

Returns the access class.

pub const fn risk(&self) -> RiskClass

Returns the risk class.

pub const fn reversibility(&self) -> Reversibility

Returns expected reversibility.

pub fn required(&self) -> &ParameterGroup

Returns fields required for every request.

pub fn required_any(&self) -> &[ParameterGroup]

Returns alternative complete parameter groups.

pub const fn planning(&self) -> CapabilitySupport

Returns planning support.

pub const fn progress(&self) -> CapabilitySupport

Returns progress support.

pub const fn cancellation(&self) -> CapabilitySupport

Returns cancellation support.

pub const fn verification(&self) -> CapabilitySupport

Returns verification support.

pub const fn fanout(&self) -> CapabilitySupport

Returns fanout support.

pub const fn retry(&self) -> RetryClass

Returns retry classification.

pub const fn idempotent(&self) -> bool

Returns whether mutation repetition is idempotent.

pub fn evidence(&self) -> impl Iterator<Item = &EvidenceKind>

Iterates over expected evidence kinds.

pub fn requirements(&self) -> impl Iterator<Item = &str>

Iterates over implementation capability requirements.

Trait Implementations

impl Clone for OperationSpec

fn clone(&self) -> OperationSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OperationSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for OperationSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for OperationSpec

fn eq(&self, other: &OperationSpec) -> 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 OperationSpec

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 OperationSpec

impl StructuralPartialEq for OperationSpec