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

//! A convenient wrapper for the [`c-ares`](http://c-ares.haxx.se) library.
//!
//! The [`c-ares` crate](https://crates.io/crates/c-ares) provides a safe
//! wrapper around the underlying C library, but it's relatively hard work to
//! use: the user needs to drive the polling of file descriptors according to
//! `c-ares` demands, which likely involves writing something close to a
//! full-blown event loop.
//!
//! This crate does that hard work for you so that the presented API is much
//! more straightforward.  Simply create a `Resolver`, and make your query -
//! providing a callback to be called when the query completes.
//!
//! This crate also provides a `FutureResolver`.  Queries on this object
//! return `futures::Future` objects, and don't use callbacks.
//!
//! On both resolvers:
//!
//! -  methods like `query_xxx` correspond to the c-ares
//! function `ares_query`, which "initiates a single-question DNS query"
//!
//! -  methods like `search_xxx` correspond to the c-ares function
//! `ares_search`, which "initiates a series of single-question DNS queries".
//!
//! See [c-ares documentation](https://c-ares.haxx.se/docs.html) for more
//! details.
//!
//! # Example
//!
//! ```rust
//! extern crate c_ares_resolver;
//! extern crate tokio_core;
//!
//! fn main() {
//!     let resolver = c_ares_resolver::FutureResolver::new().unwrap();
//!     let query = resolver.query_a("google.com");
//!     let mut event_loop = tokio_core::reactor::Core::new().unwrap();
//!     let result = event_loop.run(query).unwrap();
//!     println!("{}", result);
//! }
//! ```
//!
//! Further examples showing how to use the library can be found
//! [here](https://github.com/dimbleby/c-ares-resolver/tree/master/examples).
#![deny(missing_docs)]
extern crate c_ares;
extern crate futures;
extern crate mio_more;

#[cfg(unix)]
extern crate mio;

#[cfg(windows)]
extern crate winapi;

#[cfg(windows)]
extern crate ws2_32;

mod error;
mod eventloop;
mod futureresolver;
mod host;
mod nameinfo;
mod resolver;

#[cfg(unix)]
mod unix;

#[cfg(windows)]
mod windows;

pub use error::Error;
pub use futureresolver::{
    CAresFuture,
    FutureResolver
};
pub use host::HostResults;
pub use nameinfo::NameInfoResult;
pub use resolver::{
    Options,
    Resolver,
};