Skip to main content

WebSocketContract

Struct WebSocketContract 

Source
pub struct WebSocketContract { /* private fields */ }
Expand description

WebSocket contract implementation

Defines message types and topics for a WebSocket connection, enabling schema validation and drift detection.

Implementations§

Source§

impl WebSocketContract

Source

pub fn new(contract_id: String, version: String) -> Self

Create a new WebSocket contract

Source

pub fn add_message_type( &mut self, message_type: WebSocketMessageType, ) -> Result<(), ContractError>

Add a message type to the contract

Source

pub fn remove_message_type(&mut self, message_type_id: &str)

Remove a message type from the contract

Source

pub fn get_message_types_for_topic( &self, topic: &str, ) -> Vec<&WebSocketMessageType>

Get message types for a specific topic

Trait Implementations§

Source§

impl ProtocolContract for WebSocketContract

Source§

fn protocol(&self) -> Protocol

Get the protocol type this contract represents
Source§

fn contract_id(&self) -> &str

Get a unique identifier for this contract
Source§

fn version(&self) -> &str

Get the contract version
Source§

fn operations(&self) -> Vec<ContractOperation>

Get all operations/methods/topics defined in this contract
Source§

fn get_operation(&self, operation_id: &str) -> Option<&ContractOperation>

Get a specific operation by identifier
Source§

fn diff<'life0, 'life1, 'async_trait>( &'life0 self, other: &'life1 dyn ProtocolContract, ) -> Pin<Box<dyn Future<Output = Result<ContractDiffResult, ContractError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compare this contract with another contract of the same protocol Read more
Source§

fn validate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, operation_id: &'life1 str, request: &'life2 ContractRequest, ) -> Pin<Box<dyn Future<Output = Result<ValidationResult, ContractError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Validate a request/message against this contract Read more
Source§

fn get_schema(&self, operation_id: &str) -> Option<Value>

Get schema information for an operation Read more
Source§

fn to_json(&self) -> Result<Value, ContractError>

Serialize the contract to a JSON representation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more