async_zmq 0.1.0

Async version for ZeroMQ bindings
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

//! # Async version for ZeroMQ bindings
//!
//! This is high-level bindings for [`zmq`] in asynchronous manner. Crate itself uses some modules from
//! [`async-std`], but it should also work on any other async runtime. The goal for this project
//! is providing simple interface that is compatible with any async executor and reactor.
//!
//! ## TODO list
//!
//! - [ ] PAIR
//! - [x] PUB
//! - [x] SUB
//! - [ ] REQ
//! - [ ] REP
//! - [ ] DEALER
//! - [ ] ROUTER
//! - [ ] PULL
//! - [ ] PUSH
//! - [ ] XPUB
//! - [ ] XSUB
//! - [ ] STREAM
//!
//! ## Usage
//!
//! Users could simply initialize any socket type with `async_zmq::*` in mind, and then call
//! `bind()` or `connect` depends on your scenario. For example, if someone wants a publish socket,
//! then he could initialize the socket like this:
//!
//! ```ignore
//! let zmq = async_zmq::publish("tcp://127.0.0.1:5555")?.bind();
//! ```
//!
//! To learn more about each socket type usage. See [modules](#modules) below.
//!
//! ### Prelude
//!
//! Prelude module provides some common types, traits and their methods. This crate also re-export
//! so it can be easier for you to import them.
//!
//! Another common issue when people adopting a library is to deal with its error handling flow.
//! To prevent introducing more overhead, `async_zmq` uses the exact same [`Result`]/[`Error`] type
//! in [`zmq`] crate and re-export them.
//!
//! [`Result`]: prelude/type.Result.html
//! [`Error`]: prelude/type.Error.html
//! [`zmq`]: https://crates.io/crates/zmq
//! [`async-std`]: https://crates.io/crates/async-std

#![deny(unused_extern_crates, unsafe_code)]
#![warn(missing_docs, rust_2018_idioms, unreachable_pub)]

pub mod dealer;
pub mod pair;
pub mod publish;
pub mod pull;
pub mod push;
pub mod reply;
pub mod request;
pub mod router;
pub mod stream;
pub mod subscribe;
pub mod xpublish;
pub mod xsubscribe;

mod evented;
mod socket;
mod watcher;

/// The prelude re-exports most commonly used traits and macros from this crate.
pub mod prelude {
    pub use crate::dealer::{dealer, Dealer};
    pub use crate::pair::{pair, Pair};
    pub use crate::publish::{publish, Publish};
    pub use crate::pull::{pull, Pull};
    pub use crate::push::{push, Push};
    pub use crate::reply::{reply, Reply};
    pub use crate::request::{request, Request};
    pub use crate::socket::{MessageBuf, SocketBuilder};
    pub use crate::stream::{stream, ZmqStream};
    pub use crate::subscribe::{subscribe, Subscribe};
    pub use crate::xpublish::{xpublish, XPublish};
    pub use crate::xsubscribe::{xsubscribe, XSubscribe};
    pub use futures::sink::{Sink, SinkExt};
    pub use futures::stream::{Stream, StreamExt};
    pub use zmq::{self, Error, Message, Result};
}

pub use prelude::*;