qubit 1.0.0-beta.2

Seamless RPC for Rust & TypeScript
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

//! TODO: Explain the utility of markers

use std::marker::PhantomData;

/// Marker trait for any markers that can be used as a [`ResponseValue`](response_value).
///
/// [response_value]: super::response::ResponseValue
pub trait ResponseMarker {}

/// Marker for anything that implements [`TS`].
pub struct MTs;
impl ResponseMarker for MTs {}

/// Marker for anything that implements [`Iterator`]. [`Iterator::Item`] (represented with the
/// `MItem` generic) can be any type that implements [`ResponseMarker`].
pub struct MIter<MItem: ResponseMarker>(PhantomData<MItem>);
impl<MItem> ResponseMarker for MIter<MItem> where MItem: ResponseMarker {}

/// Marker trait for any markers that can be used as a return value from [`QubitHandler`].
pub trait HandlerReturnMarker {}

/// Marker for any [`ResponseMarker`] which is directly returned.
pub struct MResponse<MValue: ResponseMarker>(PhantomData<MValue>);
impl<MValue> HandlerReturnMarker for MResponse<MValue> where MValue: ResponseMarker {}

/// Marker for any returned [`Futures`][Future]. The result of the future [`MReturn`] may be any
/// other [`HandlerReturnMarker`].
pub struct MFuture<MReturn: HandlerReturnMarker>(PhantomData<MReturn>);
impl<MReturn> HandlerReturnMarker for MFuture<MReturn> where MReturn: HandlerReturnMarker {}

/// Marker for a [`Stream`](futures::stream::Stream), consisting of [`ResponseMarker`].
pub struct MStream<MValue: ResponseMarker>(PhantomData<MValue>);
impl<MValue> HandlerReturnMarker for MStream<MValue> where MValue: ResponseMarker {}