lib-ngrok 0.2.1

Ngrok downloader and runner.
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

//! Easily download and run an ngrok binary.
//!
//! # Examples
//!
//! ```rust
//! use lib_ngrok::download;
//!
//! async fn download() -> Result<(), anyhow::Error> {
//!     let ngrok_path = &Path::new("ngrok");
//!     download::bin(ngrok_path).await?;
//! }
//! ```

use std::{
    ffi::OsStr,
    io,
    path::Path,
    process::{Command, ExitStatus},
};
use thiserror::Error;

pub mod url;

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

/// Errors that can occur when running an ngrok binary.
#[derive(Error, Debug)]
pub enum RunError {
    #[error("could not run ngrok. status: {0}")]
    CouldNotRun(ExitStatus),
    #[error("could not find ngrok binary")]
    CouldNotFindBinary,
    #[error("io")]
    IO(#[from] io::Error),
}

/// Runs an ngrok binary with an authentication token.
///
/// Make sure that the bin is an ngrok path.
///
/// The `auth_token` parameter sets an enviornemnt variable `NGROK_AUTHTOKEN` to what you specify.
pub fn run<T: AsRef<OsStr>>(bin: &Path, auth_token: &str, args: &[T]) -> Result<(), RunError> {
    let mut child = Command::new(bin)
        .env("NGROK_AUTHTOKEN", auth_token)
        .args(args)
        .spawn()?;

    let status = child.wait()?;

    if !status.success() {
        return Err(RunError::CouldNotRun(status));
    }

    Ok(())
}