interprocess 2.2.2

Interprocess communication toolkit
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
67
68

use super::super::*;

/// Tags for [`PipeStream`]'s generic arguments that specify the directionality of the stream and
/// how it receives and/or sends data (as bytes or as messages).
///
/// This is a sort of const-generic incarnation of the [`PipeMode`] enumeration that allows
/// `PipeStream` to be consolidated into a single struct with generic parameters that decide which
/// traits are implemented on it.
///
/// Some examples of how different `PipeStream` signatures would look:
/// -	**`PipeStream<Bytes, Bytes>`** (or, thanks to default generic arguments, simply `PipeStream`)
/// 	is a duplex stream that receives and sends bytes.
/// -	**`PipeStream<Messages, ()>`** is a receive-only message stream.
/// -	**`PipeStream<Bytes, Messages>`** is a duplex stream that receives bytes but sends messages.
pub mod pipe_mode {
	use super::*;

	mod seal {
		use super::*;
		pub trait PipeModeTag: Copy + std::fmt::Debug + Eq + Send + Sync + Unpin {
			const MODE: Option<PipeMode>;
			#[cfg(feature = "tokio")]
			type TokioFlusher: std::fmt::Debug + Default;
		}
		#[cfg(feature = "tokio")]
		pub trait NotNone:
			PipeModeTag<TokioFlusher = crate::os::windows::tokio_flusher::TokioFlusher>
		{
		}
		#[cfg(not(feature = "tokio"))]
		pub trait NotNone: PipeModeTag {}
	}
	pub(crate) use seal::*;

	macro_rules! present_tag {
		($(#[$attr:meta])* $tag:ident is $mode:expr ; no_tokio_flusher) => {
				tag_enum!($( #[$attr] )* $tag);
				impl PipeModeTag for $tag {
					const MODE: Option<PipeMode> = $mode;
					#[cfg(feature = "tokio")]
					type TokioFlusher = ();
				}
		};
		($(#[$attr:meta])* $tag:ident is $mode:expr) => {
				tag_enum!($( #[$attr] )* $tag);
				impl PipeModeTag for $tag {
					const MODE: Option<PipeMode> = $mode;
					#[cfg(feature = "tokio")]
					type TokioFlusher = crate::os::windows::tokio_flusher::TokioFlusher;
				}
		};
		($($(#[$attr:meta])* $tag:ident is $mode:expr $(; $yayornay:ident)?),+ $(,)?) => {
			$(present_tag!($( #[$attr] )* $tag is $mode $(; $yayornay)?);)+
		};
	}

	present_tag! {
		/// Tags a direction of a [`PipeStream`] to be absent.
		None is None ; no_tokio_flusher,
		/// Tags a direction of a [`PipeStream`] to be present with byte-wise semantics.
		Bytes is Some(PipeMode::Bytes),
		/// Tags a direction of a [`PipeStream`] to be present with message-wise semantics.
		Messages is Some(PipeMode::Messages),
	}
	impl NotNone for Bytes {}
	impl NotNone for Messages {}
}
pub(crate) use pipe_mode::{NotNone as PmtNotNone, PipeModeTag};