agplatform 0.4.1

Platform providing env, fs, request and process infrastructure for production and testing
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

#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

mod error;
#[cfg(feature = "env")]
#[macro_use]
mod env;
#[cfg(feature = "fs")]
#[macro_use]
mod fs;
#[cfg(feature = "env")]
mod platform;
#[cfg(feature = "process")]
#[macro_use]
mod process;
#[cfg(feature = "request")]
#[macro_use]
mod request;
#[cfg(all(feature = "testing", feature = "env"))]
pub mod test_platform;
#[cfg(any(test, feature = "testing"))]
mod testing;
#[cfg(feature = "env")]
mod utils;

#[cfg(feature = "env")]
pub use env::{Env, EnvArgs, EnvVars};
pub use error::Error;
pub use error::ErrorKind;
#[cfg(feature = "fs")]
pub use fs::{DirEntry, FileType, Fs, Metadata, OpenWriteOptions, ReadFile, WriteFile};
#[cfg(feature = "env")]
pub use platform::Platform;
#[cfg(all(feature = "process", feature = "tokio"))]
pub use process::CommandCancelled;
#[cfg(feature = "process")]
pub use process::{
    AcceptIf, CommandExt, CommandOptions, CommandOutput, CommandRun, OutputStream, Process,
    ProcessObserver, RetryIf,
};
#[cfg(feature = "request")]
pub use request::{
    BlockingRequestBuilderExt, ConfiguredRequest, Request, RequestAcceptIf, RequestObserver,
    RequestOptions, RequestOutput, RequestRetryIf, RequestRun, TransportError, TransportErrorKind,
};
#[cfg(all(feature = "request", feature = "tokio"))]
pub use request::{RequestBuilderExt, RequestCancelled};
#[cfg(feature = "request")]
pub use reqwest;
#[cfg(all(feature = "testing", feature = "env"))]
pub use test_platform::test_env::TestEnv;
#[cfg(all(feature = "testing", feature = "fs"))]
pub use test_platform::test_fs::TestFs;
#[cfg(all(feature = "testing", feature = "process"))]
pub use test_platform::test_process::{TestCall, TestProcess, TestProcessGate};
#[cfg(all(feature = "testing", feature = "request"))]
pub use test_platform::test_request::{TestGate, TestRequest, TestRequestCall};
#[cfg(any(test, feature = "testing"))]
pub use testing::{TestDir, TestFile};

pub type Result<T = ()> = std::result::Result<T, Error>;

/// Enabled by the `env` feature flag.
///
/// Returns an opaque default platform implementation.
#[cfg(feature = "env")]
pub fn platform() -> impl platform::Platform {
    let env = env::EnvImpl::new_from_std();
    #[cfg(feature = "fs")]
    let fs = fs::FsImpl::with_env(env.shared.clone());
    #[cfg(feature = "process")]
    let process = process::ProcessImpl::with_env(env.shared.clone());
    #[cfg(feature = "request")]
    let request = request::RequestImpl::with_env(env.shared.clone());

    platform::PlatformImpl {
        env,
        #[cfg(feature = "fs")]
        fs,
        #[cfg(feature = "process")]
        process,
        #[cfg(feature = "request")]
        request,
    }
}