Struct EffectInterfaceMetadata 

pub struct EffectInterfaceMetadata {
    pub interface_name: String,
    pub operation_name: String,
    pub authority_class: EffectAuthorityClass,
    pub semantic_class: EffectSemanticClass,
    pub agreement_use: EffectAgreementUse,
    pub region_scope: EffectRegionScope,
    pub admissibility: EffectAdmissibility,
    pub totality: EffectTotality,
    pub timeout_policy: EffectTimeoutPolicy,
    pub retry_shape: EffectRetryShape,
    pub reentrancy_policy: EffectReentrancyPolicy,
    pub handler_domain: EffectHandlerDomain,
}

Runtime metadata for one effect interface operation.

Fields

interface_name: String

Nominal effect interface name.

operation_name: String

Nominal effect operation name.

authority_class: EffectAuthorityClass

Authority class for this operation.

semantic_class: EffectSemanticClass

Semantic class for this operation.

agreement_use: EffectAgreementUse

Agreement-use discipline for this operation.

region_scope: EffectRegionScope

Region scope for this operation.

admissibility: EffectAdmissibility

Admission policy for this operation.

totality: EffectTotality

Totality contract for this operation.

timeout_policy: EffectTimeoutPolicy

Timeout contract for this operation.

retry_shape: EffectRetryShape

Retry shape for this operation.

reentrancy_policy: EffectReentrancyPolicy

Reentrancy policy for this operation.

handler_domain: EffectHandlerDomain

Handler domain expected to interpret this operation.

Implementations

impl EffectInterfaceMetadata

pub fn is_authoritative(&self) -> bool

Whether the effect is authoritative.

pub fn is_command(&self) -> bool

Whether the effect is a command surface.

pub fn is_observe(&self) -> bool

Whether the effect is observational.

pub fn is_immediate(&self) -> bool

Whether the effect must complete immediately.

pub fn timeout_required(&self) -> bool

Whether the effect requires an explicit timeout contract.

pub fn has_explicit_retry_rule(&self) -> bool

Whether the effect declares an explicit retry rule.

pub fn architecturally_legal(&self) -> bool

Whether the metadata combination is architecturally legal.

pub fn immediate_admissible(&self) -> bool

Whether an immediate effect is admissible on the semantic path.

pub fn reentrancy_admissible( &self, active: &EffectResponsibilityDomain, incoming: &EffectResponsibilityDomain, ) -> bool

Whether one incoming request is admissible relative to one active request.

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

Validate one metadata combination.

Errors

Returns a contract error when the metadata encodes an illegal combination.

pub fn for_effect_kind(effect_kind: &str) -> Self

Default runtime metadata for one built-in effect kind.

Trait Implementations

impl Clone for EffectInterfaceMetadata

fn clone(&self) -> EffectInterfaceMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectInterfaceMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectInterfaceMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EffectInterfaceMetadata

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

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 EffectInterfaceMetadata

impl StructuralPartialEq for EffectInterfaceMetadata