uutils/uutils.github.io
0
0
Fork 0
mirror of https://github.com/uutils/uutils.github.io.git synced 2026-06-10 16:12:28 -07:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
uutils.github.io/coreutils/dev/uucore/index.html
T
tertsdiepraam 878d4de11f deploy: 64ff55be0e
2023-08-21 09:25:37 +00:00

1 line
15 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `uucore` crate."><title>uucore - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-f3501f0f5ae15dfb.css" id="mainThemeStyle"><div id="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="uucore" data-themes="" data-resource-suffix="" data-rustdoc-version="1.71.1 (eb26296b5 2023-08-03)" data-search-js="search-4926e5fc22a5646a.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ></div><script src="../static.files/storage-62ce34ea385b278a.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-f0540c1d82cde29b.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../uucore/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../uucore/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate uucore</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.0.20</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#attributes">Attribute Macros</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">uucore</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/uucore/lib.rs.html#11-297">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name"><code>pub extern crate libc;</code></div></li></ul><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="backup_control/index.html" title="mod uucore::backup_control">backup_control</a></div><div class="desc docblock-short">Implement GNU-style backup functionality.</div></li><li><div class="item-name"><a class="mod" href="display/index.html" title="mod uucore::display">display</a></div></li><li><div class="item-name"><a class="mod" href="encoding/index.html" title="mod uucore::encoding">encoding</a></div></li><li><div class="item-name"><a class="mod" href="entries/index.html" title="mod uucore::entries">entries</a></div><div class="desc docblock-short">Get password/group file entry</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod uucore::error">error</a></div><div class="desc docblock-short">All utils return exit with an exit code. Usually, the following scheme is used:</div></li><li><div class="item-name"><a class="mod" href="fs/index.html" title="mod uucore::fs">fs</a></div><div class="desc docblock-short">Set of functions to manage files and symlinks</div></li><li><div class="item-name"><a class="mod" href="fsext/index.html" title="mod uucore::fsext">fsext</a></div><div class="desc docblock-short">Set of functions to manage file systems</div></li><li><div class="item-name"><a class="mod" href="line_ending/index.html" title="mod uucore::line_ending">line_ending</a></div><div class="desc docblock-short">Provides consistent newline/zero terminator handling for <code>-z</code>/<code>--zero</code> flags.</div></li><li><div class="item-name"><a class="mod" href="lines/index.html" title="mod uucore::lines">lines</a></div><div class="desc docblock-short">Iterate over lines, including the line ending character(s).</div></li><li><div class="item-name"><a class="mod" href="memo/index.html" title="mod uucore::memo">memo</a></div><div class="desc docblock-short">Main entry point for our implementation of printf.</div></li><li><div class="item-name"><a class="mod" href="mode/index.html" title="mod uucore::mode">mode</a></div><div class="desc docblock-short">Set of functions to parse modes</div></li><li><div class="item-name"><a class="mod" href="os/index.html" title="mod uucore::os">os</a></div></li><li><div class="item-name"><a class="mod" href="panic/index.html" title="mod uucore::panic">panic</a></div><div class="desc docblock-short">Custom panic hooks that allow silencing certain types of errors.</div></li><li><div class="item-name"><a class="mod" href="parse_glob/index.html" title="mod uucore::parse_glob">parse_glob</a></div><div class="desc docblock-short">Parsing a glob Pattern from a string.</div></li><li><div class="item-name"><a class="mod" href="parse_size/index.html" title="mod uucore::parse_size">parse_size</a></div></li><li><div class="item-name"><a class="mod" href="parse_time/index.html" title="mod uucore::parse_time">parse_time</a></div><div class="desc docblock-short">Parsing a duration from a string.</div></li><li><div class="item-name"><a class="mod" href="perms/index.html" title="mod uucore::perms">perms</a></div><div class="desc docblock-short">Common functions to manage permissions</div></li><li><div class="item-name"><a class="mod" href="pipes/index.html" title="mod uucore::pipes">pipes</a></div></li><li><div class="item-name"><a class="mod" href="process/index.html" title="mod uucore::process">process</a></div><div class="desc docblock-short">Set of functions to manage IDs</div></li><li><div class="item-name"><a class="mod" href="quoting_style/index.html" title="mod uucore::quoting_style">quoting_style</a></div></li><li><div class="item-name"><a class="mod" href="ranges/index.html" title="mod uucore::ranges">ranges</a></div></li><li><div class="item-name"><a class="mod" href="ringbuffer/index.html" title="mod uucore::ringbuffer">ringbuffer</a></div><div class="desc docblock-short">A fixed-size ring buffer.</div></li><li><div class="item-name"><a class="mod" href="shortcut_value_parser/index.html" title="mod uucore::shortcut_value_parser">shortcut_value_parser</a></div></li><li><div class="item-name"><a class="mod" href="signals/index.html" title="mod uucore::signals">signals</a></div></li><li><div class="item-name"><a class="mod" href="sum/index.html" title="mod uucore::sum">sum</a></div><div class="desc docblock-short">Implementations of digest functions, like md5 and sha1.</div></li><li><div class="item-name"><a class="mod" href="update_control/index.html" title="mod uucore::update_control">update_control</a></div><div class="desc docblock-short">Implement GNU-style update functionality.</div></li><li><div class="item-name"><a class="mod" href="utmpx/index.html" title="mod uucore::utmpx">utmpx</a></div><div class="desc docblock-short">Aims to provide platform-independent methods to obtain login records</div></li><li><div class="item-name"><a class="mod" href="version_cmp/index.html" title="mod uucore::version_cmp">version_cmp</a></div></li></ul><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.bin.html" title="macro uucore::bin">bin</a></div><div class="desc docblock-short">Execute utility code for <code>util</code>.</div></li><li><div class="item-name"><a class="macro" href="macro.crash.html" title="macro uucore::crash">crash</a></div><div class="desc docblock-short">Display an error and <a href="https://doc.rust-lang.org/1.71.1/std/process/fn.exit.html" title="fn std::process::exit"><code>std::process::exit</code></a></div></li><li><div class="item-name"><a class="macro" href="macro.crash_if_err.html" title="macro uucore::crash_if_err">crash_if_err</a></div><div class="desc docblock-short">Unwrap a <a href="https://doc.rust-lang.org/1.71.1/core/result/enum.Result.html" title="enum core::result::Result"><code>std::result::Result</code></a>, crashing instead of panicking.</div></li><li><div class="item-name"><a class="macro" href="macro.has.html" title="macro uucore::has">has</a></div><div class="desc docblock-short">Used to check if the <code>mode</code> has its <code>perm</code> bit set.</div></li><li><div class="item-name"><a class="macro" href="macro.help_about.html" title="macro uucore::help_about">help_about</a></div><div class="desc docblock-short">Get the about text from the help file.</div></li><li><div class="item-name"><a class="macro" href="macro.help_section.html" title="macro uucore::help_section">help_section</a></div><div class="desc docblock-short">Reads a section from a file of the util as a <code>str</code> literal.</div></li><li><div class="item-name"><a class="macro" href="macro.help_usage.html" title="macro uucore::help_usage">help_usage</a></div><div class="desc docblock-short">Get the usage from the help file.</div></li><li><div class="item-name"><a class="macro" href="macro.prompt_yes.html" title="macro uucore::prompt_yes">prompt_yes</a></div><div class="desc docblock-short">Prompt the user with a formatted string and returns <code>true</code> if they reply <code>'y'</code> or <code>'Y'</code></div></li><li><div class="item-name"><a class="macro" href="macro.show.html" title="macro uucore::show">show</a></div><div class="desc docblock-short">Display a <a href="error/trait.UError.html" title="trait uucore::error::UError"><code>crate::error::UError</code></a> and set global exit code.</div></li><li><div class="item-name"><a class="macro" href="macro.show_error.html" title="macro uucore::show_error">show_error</a></div><div class="desc docblock-short">Show an error to stderr in a similar style to GNU coreutils.</div></li><li><div class="item-name"><a class="macro" href="macro.show_if_err.html" title="macro uucore::show_if_err">show_if_err</a></div><div class="desc docblock-short">Display an error and set global exit code in error case.</div></li><li><div class="item-name"><a class="macro" href="macro.show_warning.html" title="macro uucore::show_warning">show_warning</a></div><div class="desc docblock-short">Print a warning message to stderr.</div></li><li><div class="item-name"><a class="macro" href="macro.uio_error.html" title="macro uucore::uio_error">uio_error</a></div><div class="desc docblock-short">Shorthand to construct <a href="error/struct.UIoError.html" title="struct uucore::error::UIoError"><code>UIoError</code></a>-instances.</div></li></ul><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Args.html" title="trait uucore::Args">Args</a></div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.args_os.html" title="fn uucore::args_os">args_os</a></div></li><li><div class="item-name"><a class="fn" href="fn.execution_phrase.html" title="fn uucore::execution_phrase">execution_phrase</a></div><div class="desc docblock-short">Derive the complete execution phrase for “usage”.</div></li><li><div class="item-name"><a class="fn" href="fn.format_usage.html" title="fn uucore::format_usage">format_usage</a></div><div class="desc docblock-short">Generate the usage string for clap.</div></li><li><div class="item-name"><a class="fn" href="fn.get_utility_is_second_arg.html" title="fn uucore::get_utility_is_second_arg">get_utility_is_second_arg</a></div></li><li><div class="item-name"><a class="fn" href="fn.read_yes.html" title="fn uucore::read_yes">read_yes</a></div><div class="desc docblock-short">Read a line from stdin and check whether the first character is <code>'y'</code> or <code>'Y'</code></div></li><li><div class="item-name"><a class="fn" href="fn.set_utility_is_second_arg.html" title="fn uucore::set_utility_is_second_arg">set_utility_is_second_arg</a></div></li><li><div class="item-name"><a class="fn" href="fn.util_name.html" title="fn uucore::util_name">util_name</a></div><div class="desc docblock-short">Derive the utility name.</div></li></ul><h2 id="attributes" class="small-section-header"><a href="#attributes">Attribute Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="attr" href="attr.main.html" title="attr uucore::main">main</a></div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink