Crate uucore

library ~ (core/bundler file)

Modules

• display
  Utilities for printing paths, with special attention paid to special characters and invalid unicode.
• error
  All utils return exit with an exit code. Usually, the following scheme is used:
• io
  Encapsulates differences between OSs regarding the access to file handles / descriptors. This is useful when dealing with lower level stdin/stdout access.
• line_ending
  Provides consistent newline/zero terminator handling for -z/--zero flags.
• os
  Test if the program is running under WSL ref: https://github.com/microsoft/WSL/issues/4555 @@ https://archive.is/dP0bz
• panic
  Custom panic hooks that allow silencing certain types of errors.
• parse_glob
  Parsing a glob Pattern from a string.
• parse_size
  Parser for sizes in SI or IEC units (multiples of 1000 or 1024 bytes).
• parse_time
  Parsing a duration from a string.
• posix
  Iterate over lines, including the line ending character(s).
• shortcut_value_parser
  A parser that accepts shortcuts for values. ShortcutValueParser is similar to clap’s PossibleValuesParser

Macros

• bin
  Execute utility code for util.
• crash
  Display an error and std::process::exit
• crash_if_err
  Unwrap a std::result::Result, crashing instead of panicking.
• help_about
  Get the about text from the help file.
• help_section
  Reads a section from a file of the util as a str literal.
• help_usage
  Get the usage from the help file.
• prompt_yes
  Prompt the user with a formatted string and returns true if they reply 'y' or 'Y'
• show
  Display a crate::error::UError and set global exit code.
• show_error
  Show an error to stderr in a similar style to GNU coreutils.
• show_if_err
  Display an error and set global exit code in error case.
• show_warning
  Print a warning message to stderr.
• show_warning_caps
  Print a warning message to stderr, prepending the utility name.
• uio_error
  Shorthand to construct UIoError-instances.

Traits

• Args
  Args contains arguments passed to the utility. It is a trait that extends Iterator<Item = OsString>. It provides utility functions to collect the arguments into a Vec<String>. The collected Vec<String> can be lossy or ignore invalid encoding.

Functions

• args_os
  Returns an iterator over the command line arguments as OsStrings. args_os() can be expensive to call
• disable_rust_signal_handlers
  Disables the custom signal handlers installed by Rust for stack-overflow handling. With those custom signal handlers processes ignore the first SIGBUS and SIGSEGV signal they receive. See https://github.com/rust-lang/rust/blob/8ac1525e091d3db28e67adcbbd6db1e1deaa37fb/src/libstd/sys/unix/stack_overflow.rs#L71-L92 for details.
• execution_phrase
  Derive the complete execution phrase for “usage”.
• format_usage
  Generate the usage string for clap.
• get_utility_is_second_arg
  Used to check if the utility is the second argument. Used to check if we were called as a multicall binary (coreutils <utility>)
• os_str_as_bytes
  Helper function for processing delimiter values (which could be non UTF-8) It converts OsString to &u8 for unix targets only On non-unix (i.e. Windows) it will just return an error if delimiter value is not UTF-8
• os_str_from_bytes
  Helper function for converting a slice of bytes into an &OsStr or OsString in non-unix targets.
• os_string_from_vec
  Helper function for making an OsString from a byte field It converts Vec<u8> to OsString for unix targets only. On non-unix (i.e. Windows) it may fail if the bytes are not valid UTF-8
• read_byte_lines
  Equivalent to std::BufRead::lines which outputs each line as a Vec<u8>, which avoids panicking on non UTF-8 input.
• read_os_string_lines
  Equivalent to std::BufRead::lines which outputs each line as an OsString This won’t panic on non UTF-8 characters on Unix, but it still will on Windows.
• read_yes
  Read a line from stdin and check whether the first character is 'y' or 'Y'
• set_utility_is_second_arg
  Change the value of UTILITY_IS_SECOND_ARG to true Used to specify that the utility is the second argument.
• util_name
  Derive the utility name.

Attribute Macros

• main
  A procedural macro to define the main function of a uutils binary.