interprocess 2.4.0

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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

#![allow(unused_macros, unused_imports)]

/// Dispatches to a symmetrically named submodule in the target OS module.
macro_rules! impmod {
    ($($osmod:ident)::+ $(as $into:ident)?) => {
        impmod!($($osmod)::+, self $(as $into)?);
    };
    ($($osmod:ident)::+, $($orig:ident $(as $into:ident)?),* $(,)?) => {
        #[cfg(unix)]
        use $crate::os::unix::$($osmod)::+::{$($orig $(as $into)?,)*};
        #[cfg(windows)]
        use $crate::os::windows::$($osmod)::+::{$($orig $(as $into)?,)*};
    };
}

/// Generates a method that projects `self.0` of type `src` to a `Pin` for type `dst`.
macro_rules! pinproj_for_unpin {
    ($src:ty, $dst:ty) => {
        impl $src {
            #[inline(always)]
            fn pinproj(&mut self) -> ::std::pin::Pin<&mut $dst> {
                ::std::pin::Pin::new(&mut self.0)
            }
        }
    };
}

/// Calls multiple macros, passing the same identifer or type as well as optional per-macro
/// parameters.
///
/// The identifier or type goes first, then comma-separated macro names without exclamation points.
/// To pass per-macro parameters, encase them in parentheses.
macro_rules! multimacro {
    ($pre:tt $ty:ident, $($macro:ident $(($($arg:tt)+))?),+ $(,)?) => {$(
        $macro!($pre $ty $(, $($arg)+)?);
    )+};
    ($pre:tt $ty:ty, $($macro:ident $(($($arg:tt)+))?),+ $(,)?) => {$(
        $macro!($pre $ty $(, $($arg)+)?);
    )+};
    ($ty:ident, $($macro:ident $(($($arg:tt)+))?),+ $(,)?) => {$(
        $macro!($ty $(, $($arg)+)?);
    )+};
    ($ty:ty, $($macro:ident $(($($arg:tt)+))?),+ $(,)?) => {$(
        $macro!($ty $(, $($arg)+)?);
    )+};
}

/// Generates a method that immutably borrows `self.0` of type `int` for type `ty`.
///
/// If `kind` is `&`, `self.0` is borrowed directly. If `kind` is `*`, `self.0` is treated as a
/// smart pointer (`Deref` is applied).
///
/// The method generated by this macro is used by forwarding macros.
macro_rules! forward_rbv {
    (@$slf:ident, &) => {
        &$slf.0
    };
    (@$slf:ident, *) => {
        &&*$slf.0
    };
    ($ty:ty, $int:ty, $kind:tt) => {
        impl $ty {
            #[inline(always)]
            fn refwd(&self) -> &$int { forward_rbv!(@self, $kind) }
        }
    };
}

#[rustfmt::skip] macro_rules! builder_must_use {() => {
"builder setters take the entire structure and return it with the corresponding field modified"
};}

/// Generates public self-by-value setters for builder structures. Assumes that a field of the same
/// name is public on `Self`.
macro_rules! builder_setters {
    ($(#[doc = $($doc:expr)+])+ $name:ident : $ty:ty) => {
        $(#[doc = $($doc)+])+
        #[must_use = builder_must_use!()]
        #[inline(always)]
        pub fn $name(mut self, $name: $ty) -> Self {
            self.$name = $name.into();
            self
        }

    };
    ($name:ident : $ty:ty) => {
        builder_setters!(
            #[doc = concat!(
                "Sets the [`",
                stringify!($name),
                "`](#structfield.", stringify!($name),
                ") parameter to the specified value."
            )]
            $name : $ty
        );
    };
    ($($(#[doc = $($doc:expr)+])* $name:ident : $ty:ty),+ $(,)?) => {
        $(builder_setters!($(#[doc = $($doc)+])* $name: $ty);)+
    };
}

/// Creates a public sealed uninhabited type with a bunch of unnecessary trait implementations.
macro_rules! tag_enum {
    ($($(#[$attr:meta])* $tag:ident),+ $(,)?) => {$(
        $( #[$attr] )*
        #[derive(Copy, Clone, Debug, PartialEq, Eq)]
        pub enum $tag {}
        #[allow(deprecated)]
        impl $crate::Sealed for $tag {}
    )+};
}

/// Generates this module's macro submodules.
macro_rules! make_macro_modules {
    ($($modname:ident),+ $(,)?) => {$(
        #[macro_use] mod $modname;
        pub(crate) use $modname::*;
    )+};
}

make_macro_modules! {
    derive_raw, derive_mut_iorw, derive_trivconv,
    forward_as_ref, forward_fmt, forward_handle_and_fd, forward_iorw, forward_to_self,
    forward_try_clone,
}