Struct CapabilityEndpointPlan 

pub struct CapabilityEndpointPlan { /* private fields */ }

Exact Capability endpoint metadata expected from one Module Instance.

Implementations

impl CapabilityEndpointPlan

pub fn new( capability_id: impl Into<String>, descriptor_version: impl Into<String>, operations: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Declares one exact Capability Descriptor and its stable Operation table.

pub fn with_admission(self, admission: RequestAdmissionPlan) -> Self

Applies one bounded admission policy to every Operation on this endpoint.

pub fn with_limits(self, queue_capacity: usize, max_concurrency: usize) -> Self

Applies queue and concurrency limits to every Operation on this endpoint.

pub fn with_operation_kind( self, operation: impl Into<String>, kind: CapabilityOperationKind, ) -> Self

Marks one declared Operation with its transport-independent interaction kind.

pub fn with_stream_operation(self, operation: impl Into<String>) -> Self

Marks one declared Operation as a bidirectional stream.

pub fn with_event_operation(self, operation: impl Into<String>) -> Self

Marks one declared Operation as an ephemeral Event.

pub fn with_event_admission(self, admission: EventAdmissionPlan) -> Self

Applies one volatile mailbox policy to every Event Operation on this endpoint.

pub fn with_event_capacity(self, capacity: usize) -> Self

Applies one volatile mailbox capacity to every Event Operation on this endpoint.

pub const fn with_cross_lane_transfer(self) -> Self

Marks the generated Capability value types as safe for native cross-lane transfer.

pub fn with_operation_admission( self, operation: impl Into<String>, admission: RequestAdmissionPlan, ) -> Self

Applies one bounded admission policy to a named Operation.

pub fn with_operation_limits( self, operation: impl Into<String>, queue_capacity: usize, max_concurrency: usize, ) -> Self

Applies queue and concurrency limits to a named Operation.

pub fn capability_id(&self) -> &str

Returns the Capability series identity.

pub fn descriptor_version(&self) -> &str

Returns the exact Descriptor version.

pub fn operations(&self) -> &[String]

Returns the exact stable Operation table.

pub fn operation_kind(&self, operation: &str) -> Option<CapabilityOperationKind>

Returns the interaction kind of one declared Operation.

pub fn stream_operations(&self) -> Vec<&str>

Returns the declared stream Operation names in Descriptor order.

pub fn request_operations(&self) -> Vec<&str>

Returns the declared request Operation names in Descriptor order.

pub fn event_operations(&self) -> Vec<&str>

Returns the declared ephemeral Event Operation names in Descriptor order.

pub const fn event_admission(&self) -> Option<EventAdmissionPlan>

Returns the endpoint-wide Event mailbox policy, when one was authored.

pub const fn supports_cross_lane_transfer(&self) -> bool

Returns whether generated values may cross native Execution Lanes without serialization.

pub fn default_admission(&self) -> Option<RequestAdmissionPlan>

Returns the endpoint-wide admission policy, when one was authored.

pub fn operation_admissions(&self) -> &BTreeMap<String, RequestAdmissionPlan>

Returns the Operation-specific admission policies.

pub fn operation_admission( &self, operation: &str, ) -> Option<RequestAdmissionPlan>

Returns the effective policy for one Operation, if one was authored.

Trait Implementations

impl Clone for CapabilityEndpointPlan

fn clone(&self) -> CapabilityEndpointPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityEndpointPlan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CapabilityEndpointPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CapabilityEndpointPlan

impl PartialEq for CapabilityEndpointPlan

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CapabilityEndpointPlan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapabilityEndpointPlan