Enhancement: `std::env::progname()`
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 1.7k
- Avg merge
- 16h 14m
- Merged PRs (30d)
- 1
Description
It is often desirable to include a short name for the program in error messages. The way for a program to learn its own name, right now, is rather verbose:
fn progname() -> String {
let argv0 = env::args_os().next().unwrap();
let exec = Path::new(&argv0).file_name().unwrap().to_str().unwrap();
String::from(if cfg!(windows) && exec.ends_with(".exe") {
exec.split_at(exec.len() - 4).0
} else {
exec
})
}
And it gets worse if you want to be diligent about the error handling.
I propose that we add std::env::progname which is the above operation with the following refinements:
-
It does not panic. It does not return Result either. It returns a predictable fixed string (e.g.
"<program name unknown>") if it can't determine the name by which the program was invoked. -
For efficiency, the result of the above path-bashing is memoized. The return type is
&'static str.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the proposed std::env::progname API and the example implementation in the issue. Determine the appropriate Rust standard-library entry point and behavior for unavailable program names, Windows executable suffixes, memoization, and a &'static str return; the work is done when those decisions are implemented and covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- operating-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100