webbrowser
| Crates.io | webbrowser |
| lib.rs | webbrowser |
| version | |
| source | src |
| created_at | 2015-12-08 20:44:31.348263 |
| updated_at | 2024-11-28 17:18:47.780394 |
| description | Open URLs in web browsers available on a platform |
| homepage | https://github.com/amodm/webbrowser-rs |
| repository | https://github.com/amodm/webbrowser-rs |
| max_upload_size | |
| id | 3597 |
| Cargo.toml error: | TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Amod Malviya (amodm)
documentation
README
webbrowser
Rust library to open URLs and local files in the web browsers available on a platform, with guarantees of Consistent Behaviour.
Inspired by the webbrowser python library
Documentation
Examples
use webbrowser;
if webbrowser::open("http://github.com").is_ok() {
// ...
}
Platform Support
| Platform | Supported | Browsers | Test status |
|---|---|---|---|
| macos | ✅ | default + others | ✅ |
| windows | ✅ | default only | ✅ |
| linux/wsl | ✅ | default only (respects $BROWSER env var, so can be used with other browsers) | ✅ |
| android | ✅ | default only | ✅ |
| ios/tvOS/visionOS | ✅ | default only | ✅ |
| wasm | ✅ | default only | ✅ |
| unix (*bsd, aix etc.) | ✅ | default only (respects $BROWSER env var, so can be used with other browsers) | Manual |
Consistent Behaviour
webbrowser defines consistent behaviour on all platforms as follows:
- Browser guarantee - This library guarantees that the browser is opened, even for local files - the only crate to make such guarantees at the time of this writing. Alternative libraries rely on existing system commands, which may lead to an editor being opened (instead of the browser) for local html files, leading to an inconsistent behaviour for users.
- Non-Blocking for GUI based browsers (e.g. Firefox, Chrome etc.), while Blocking for text based browser (e.g. lynx etc.)
- Suppressed output by default for GUI based browsers, so that their stdout/stderr don't pollute the main program's output. This can be
overridden by
webbrowser::open_browser_with_options.
Crate Features
webbrowser optionally allows the following features to be configured:
hardened- this disables handling of non-http(s) urls (e.g.file:///) as a hard security precautiondisable-wsl- this disables WSLfileimplementation (httpstill works)wasm-console- this enables logging to wasm console (valid only on wasm platform)
Looking to contribute?
PRs invited for
- Bugs
- Supporting non-default browser invocation on any platform
Important note (while testing):
- This library requires availability of browsers and a graphical environment during runtime
cargo testwill actually open the browser locally
When contributing, please note that your work will be dual licensed as MIT + Apache-2.0 (see below).
License
SPDX-License-Identifier: Apache-2.0 OR MIT
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.