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

//! # tokio-unix-ipc
//!
//! This crate implements a minimal abstraction over UNIX domain sockets for
//! the purpose of IPC on top of tokio. It lets you send both file handles and
//! rust objects between processes. This is a replacement for my earlier
//! [unix-ipc](https://github.com/mitsuhiko/unix-ipc) crate.
//!
//! ## How it works
//!
//! This uses [serde](https://serde.rs/) to serialize data over unix sockets
//! via [bincode](https://github.com/bincode-org/bincode). Thanks to the
//! [`Handle`](crate::serde::Handle) abstraction you can also send any object
//! across that is convertable into a unix file handle.
//!
//! The way this works under the hood is that during serialization and
//! deserialization encountered file descriptors are tracked. They are then
//! sent over the unix socket separately. This lets unassociated processes
//! share file handles.
//!
//! If you only want the unix socket abstraction you can disable all default
//! features and use the raw channels.
//!
//! ## Features
//!
//! * `serde`: enables support for the non raw types
//! * `serde-structural`: enables support for structural data passing
//! * `bootstrap`: adds support for boostrapping
//! * `panic-support`: adds support for IPC panic catching
//! * `backtrace`: adds support for backtraces to panics
mod raw_channel;

#[cfg(feature = "serde")]
pub mod serde;

#[cfg(feature = "serde")]
mod typed_channel;

#[cfg(feature = "panic-support")]
pub mod panic;

#[cfg(feature = "bootstrap")]
mod bootstrap;

pub use self::raw_channel::*;

#[cfg(feature = "serde")]
pub use self::typed_channel::*;

#[cfg(feature = "bootstrap")]
pub use self::bootstrap::*;

#[doc(hidden)]
#[cfg(feature = "serde")]
pub use ::serde_ as _serde_ref;