rsocket_rust 0.7.2

rsocket-rust is an implementation of the RSocket protocol in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

use std::future::Future;
use std::pin::Pin;

use async_trait::async_trait;
use futures::Stream;

use crate::payload::{Payload, SetupPayload};
use crate::Result;

pub type ClientResponder = Box<dyn Send + Sync + Fn() -> Box<dyn RSocket>>;
pub type ServerResponder =
    Box<dyn Send + Sync + Fn(SetupPayload, Box<dyn RSocket>) -> Result<Box<dyn RSocket>>>;

pub type Flux<T> = Pin<Box<dyn Send + Stream<Item = T>>>;

/// A contract providing different interaction models for RSocket protocol.
///
/// RSocket trait is based on `async_trait` crate.
///
/// # Example
/// ```
/// use rsocket_rust::prelude::*;
/// use rsocket_rust::{async_trait, stream, Result};
///
/// struct ExampleRSocket;
///
/// #[async_trait]
/// impl RSocket for ExampleRSocket {
///     async fn metadata_push(&self, req: Payload) -> Result<()> {
///         Ok(())
///     }
///
///     async fn fire_and_forget(&self, req: Payload) -> Result<()> {
///         Ok(())
///     }
///
///     async fn request_response(&self, req: Payload) -> Result<Option<Payload>> {
///         Ok(Some(Payload::builder().set_data_utf8("bingo").build()))
///     }
///
///     fn request_stream(&self, req: Payload) -> Flux<Result<Payload>> {
///         Box::pin(stream! {
///             for _ in 0..3 {
///                 yield Ok(Payload::builder().set_data_utf8("next payload").build());
///             }
///         })
///     }
///
///     fn request_channel(&self, reqs: Flux<Result<Payload>>) -> Flux<Result<Payload>> {
///         reqs
///     }
/// }
/// ```
#[async_trait]
pub trait RSocket: Sync + Send {
    /// Metadata-Push interaction model of RSocket.
    async fn metadata_push(&self, req: Payload) -> Result<()>;
    /// Fire and Forget interaction model of RSocket.
    async fn fire_and_forget(&self, req: Payload) -> Result<()>;
    /// Request-Response interaction model of RSocket.
    async fn request_response(&self, req: Payload) -> Result<Option<Payload>>;
    /// Request-Stream interaction model of RSocket.
    fn request_stream(&self, req: Payload) -> Flux<Result<Payload>>;
    /// Request-Channel interaction model of RSocket.
    fn request_channel(&self, reqs: Flux<Result<Payload>>) -> Flux<Result<Payload>>;
}