Skip to main content

MessagePatternDefinition

Struct MessagePatternDefinition 

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

Framework-neutral message pattern handler definition.

Implementations§

Source§

impl MessagePatternDefinition

Source

pub fn request<H, Fut, R>( pattern: impl Into<String>, handler: H, ) -> Result<Self>
where H: Fn(TransportMessage) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: IntoTransportReply + Send + 'static,

Source

pub fn request_scoped<F, H, Fut, R>( pattern: impl Into<String>, factory: F, ) -> Result<Self>
where F: Fn(&ModuleRef) -> Result<H> + Send + Sync + 'static, H: Fn(TransportMessage) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: IntoTransportReply + Send + 'static,

Build a request-response pattern whose handler is created from the current message dispatch’s dependency-injection scope.

Source

pub fn event<H, Fut>(pattern: impl Into<String>, handler: H) -> Result<Self>
where H: Fn(TransportMessage) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Source

pub fn event_scoped<F, H, Fut>( pattern: impl Into<String>, factory: F, ) -> Result<Self>
where F: Fn(&ModuleRef) -> Result<H> + Send + Sync + 'static, H: Fn(TransportMessage) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Build an event pattern whose handler is created from the current message dispatch’s dependency-injection scope.

Source

pub fn request_json<T, H, Fut, R>( pattern: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn request_validated_json<T, H, Fut, R>( pattern: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Validate + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<R>> + Send + 'static, R: Serialize + Send + 'static,

Source

pub fn event_json<T, H, Fut>( pattern: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Source

pub fn event_validated_json<T, H, Fut>( pattern: impl Into<String>, handler: H, ) -> Result<Self>
where T: DeserializeOwned + Validate + Send + 'static, H: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Source

pub fn pattern(&self) -> &str

Source

pub fn kind(&self) -> MessagePatternKind

Source

pub fn is_scoped(&self) -> bool

Return whether this pattern constructs its handler from each dispatch scope.

Source

pub fn module_name(&self) -> Option<&str>

Source

pub fn metadata(&self) -> &BTreeMap<String, Value>

Source

pub fn metadata_value(&self, key: &str) -> Option<&Value>

Source

pub fn with_metadata<V>(self, key: impl Into<String>, value: V) -> Result<Self>
where V: Serialize,

Source

pub fn with_metadata_value(self, key: impl Into<String>, value: Value) -> Self

Source

pub fn with_pipe<P>(self, pipe: P) -> Self
where P: TransportPipe,

Source

pub fn with_guard<G>(self, guard: G) -> Self
where G: TransportGuard,

Source

pub fn with_execution_guard<G>(self, guard: G) -> Self
where G: Guard,

Source

pub fn with_interceptor<I>(self, interceptor: I) -> Self

Source

pub fn with_execution_interceptor<I>(self, interceptor: I) -> Self

Source

pub fn with_filter<F>(self, filter: F) -> Self

Source

pub fn with_catch_filter<I, F>(self, kinds: I, filter: F) -> Self

Source

pub fn with_validation(self) -> Self

Source

pub fn with_validation_options(self, options: ValidationOptions) -> Self

Source

pub fn without_validation(self) -> Self

Source

pub fn with_payload_validation<T>(self) -> Self
where T: DeserializeOwned + Validate + 'static,

Source

pub fn with_payload_validation_options<T>( self, options: ValidationOptions, ) -> Self

Source

pub async fn dispatch( &self, message: TransportMessage, ) -> Result<Option<TransportReply>>

Trait Implementations§

Source§

impl Clone for MessagePatternDefinition

Source§

fn clone(&self) -> MessagePatternDefinition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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