Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.25 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.25 KB

mousetrap-rs

Crates.io Docs.rs

Rust implementation of https://github.com/inconshreveable/mousetrap, which is used in ngrok.

mousetrap is a tiny library that answers a single question.

On a Windows machine, was the process invoked by someone double-clicking on the executable file while browsing in explorer?

mousetrap provides a way to detect these invocations so that you can provide more helpful behavior and instructions on how to run the CLI tool.

On non-Windows platforms, this library always returns false.

Installation

Add this to your Cargo.toml:

[dependencies]
mousetrap = "0.1"

Usage

use std::io;

fn main() {
    println!("started_by_explorer: {}", mousetrap::started_by_explorer());

    println!("Press Enter to exit...");

    let mut s = String::new();
    io::stdin().read_line(&mut s).unwrap();
}

More

This is my first contribution to the Rust community. I hope you find it useful.

And I'm not familiar with Rust currently, so if you have any suggestions, feel free to open an issue or PR.

License

MIT