fire-stream-api 0.3.4

A more or less simple communication protocol library.
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

use crate::message::Action;
use crate::error::ApiError;
#[cfg(feature = "connection")]
use crate::{
	message::Message,
	error::Error,
	server::{Data, Session}
};

#[cfg(feature = "connection")]
use stream::standalone_util::PinnedFuture;


/// Basic request definition.
pub trait Request {
	type Action: Action;
	type Response;
	type Error: ApiError;

	const ACTION: Self::Action;
}

#[cfg(feature = "connection")]
pub trait RequestHandler<B> {
	type Action: Action;

	fn action() -> Self::Action
	where Self: Sized;

	/// if the data is not available just panic
	fn validate_data(&self, data: &Data);

	/// handles a message with Self::ACTION as action.
	/// 
	/// if None is returned the request is abandoned and
	/// the requestor receives a RequestDropped error
	fn handle<'a>(
		&'a self,
		msg: Message<Self::Action, B>,
		data: &'a Data,
		session: &'a Session
	) -> PinnedFuture<'a, Result<Message<Self::Action, B>, Error>>;
}