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

//! This crate shares common functionality across the `heim` sub-crates.
//!
//! Do **NOT** use it directly.

#![doc(html_root_url = "https://docs.rs/heim-common/0.1.0-rc.1")]
#![deny(
    unused,
    unused_imports,
    unused_features,
    bare_trait_objects,
    future_incompatible,
    missing_debug_implementations,
    missing_docs,
    nonstandard_style,
    dead_code,
    deprecated,
    broken_intra_doc_links
)]
#![warn(
    trivial_casts,
    trivial_numeric_casts,
    unused_extern_crates,
    unused_import_braces,
    unused_results
)]
#![allow(clippy::missing_safety_doc)]
#![cfg_attr(docsrs, feature(doc_cfg))]

mod errors;
mod macros;
#[doc(hidden)]
pub mod sys;
pub mod units;
#[doc(hidden)]
pub mod utils;

pub use self::errors::{Context, Error, Result};

/// Process identifier type.
#[cfg(unix)]
pub type Pid = libc::pid_t;

/// Process identifier type.
// TODO: Is it a correct type for pid?
#[cfg(target_os = "windows")]
pub type Pid = winapi::shared::minwindef::DWORD;

/// Prelude intended to be used across `heim-*` crates.
///
/// Consider not to use it in your code, because it is kinda internal
/// and might change at any time.
pub mod prelude {
    pub use super::errors::{Error, Result};
    pub use super::wrap;

    /// This module tries to mimic `futures` crate structure
    /// except without re-exporting unused subcrates like `executor` or `compat`.
    pub mod futures {
        pub use futures_util::ready;
        pub use futures_util::task;

        /// Asynchronous values.
        pub mod future {
            pub use futures_core::future::*;
            pub use futures_util::future::*;
        }

        /// Asynchronous streams.
        pub mod stream {
            pub use futures_core::stream::*;
            pub use futures_util::stream::*;
        }
    }

    // And these re-exports are used across the `heim-*` crates,
    // would be bad to break them
    pub use self::futures::future::{
        self, BoxFuture, FusedFuture, Future, FutureExt, TryFutureExt,
    };
    pub use self::futures::stream::{
        self, BoxStream, FusedStream, Stream, StreamExt, TryStreamExt,
    };
}