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/fs/index.html
T
tertsdiepraam 878d4de11f deploy: 64ff55be0e
2023-08-21 09:25:37 +00:00

13 lines
9.8 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="Set of functions to manage files and symlinks"><title>uucore::fs - 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="../../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"><!--[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="#">Module fs</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</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>Module <a href="../index.html">uucore</a>::<wbr><a class="mod" href="#">fs</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/features/fs.rs.html#9-878">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Set of functions to manage files and symlinks</p>
</div></details><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.has.html" title="macro uucore::fs::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></ul><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FileInformation.html" title="struct uucore::fs::FileInformation">FileInformation</a></div><div class="desc docblock-short">Information to uniquely identify a file</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.MissingHandling.html" title="enum uucore::fs::MissingHandling">MissingHandling</a></div><div class="desc docblock-short">Controls how symbolic links should be handled when canonicalizing a path.</div></li><li><div class="item-name"><a class="enum" href="enum.ResolveMode.html" title="enum uucore::fs::ResolveMode">ResolveMode</a></div><div class="desc docblock-short">Controls when symbolic links are resolved</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.are_hardlinks_or_one_way_symlink_to_same_file.html" title="fn uucore::fs::are_hardlinks_or_one_way_symlink_to_same_file">are_hardlinks_or_one_way_symlink_to_same_file</a></div><div class="desc docblock-short">Checks if either two paths are hard links to the same file or if the source path is a symbolic link which when fully resolved points to target path</div></li><li><div class="item-name"><a class="fn" href="fn.are_hardlinks_to_same_file.html" title="fn uucore::fs::are_hardlinks_to_same_file">are_hardlinks_to_same_file</a></div><div class="desc docblock-short">Checks if two paths are hard links to the same file.</div></li><li><div class="item-name"><a class="fn" href="fn.canonicalize.html" title="fn uucore::fs::canonicalize">canonicalize</a></div><div class="desc docblock-short">Return the canonical, absolute form of a path.</div></li><li><div class="item-name"><a class="fn" href="fn.dir_strip_dot_for_creation.html" title="fn uucore::fs::dir_strip_dot_for_creation">dir_strip_dot_for_creation</a></div><div class="desc docblock-short">For some programs like install or mkdir, dir/. can be provided
Special case to match GNU’s behavior:
install -d foo/. should work and just create foo/
std::fs::create_dir(“foo/.”); fails in pure Rust</div></li><li><div class="item-name"><a class="fn" href="fn.display_permissions.html" title="fn uucore::fs::display_permissions">display_permissions</a></div><div class="desc docblock-short">Display the permissions of a file
On non unix like system, just show ‘–––––’</div></li><li><div class="item-name"><a class="fn" href="fn.display_permissions_unix.html" title="fn uucore::fs::display_permissions_unix">display_permissions_unix</a></div><div class="desc docblock-short">Display the permissions of a file on a unix like system</div></li><li><div class="item-name"><a class="fn" href="fn.infos_refer_to_same_file.html" title="fn uucore::fs::infos_refer_to_same_file">infos_refer_to_same_file</a></div><div class="desc docblock-short">Checks if <code>p1</code> and <code>p2</code> are the same file information.
If error happens when trying to get files’ metadata, returns false</div></li><li><div class="item-name"><a class="fn" href="fn.is_symlink_loop.html" title="fn uucore::fs::is_symlink_loop">is_symlink_loop</a></div><div class="desc docblock-short">Checks if there is a symlink loop in the given path.</div></li><li><div class="item-name"><a class="fn" href="fn.make_path_relative_to.html" title="fn uucore::fs::make_path_relative_to">make_path_relative_to</a></div><div class="desc docblock-short">Converts absolute <code>path</code> to be relative to absolute <code>to</code> path.</div></li><li><div class="item-name"><a class="fn" href="fn.normalize_path.html" title="fn uucore::fs::normalize_path">normalize_path</a></div><div class="desc docblock-short">Normalize a path by removing relative information
For example, convert ‘bar/../foo/bar.txt’ =&gt; ‘foo/bar.txt’
copied from <code>&lt;https://github.com/rust-lang/cargo/blob/2e4cfc2b7d43328b207879228a2ca7d427d188bb/src/cargo/util/paths.rs#L65-L90&gt;</code>
both projects are MIT <code>&lt;https://github.com/rust-lang/cargo/blob/master/LICENSE-MIT&gt;</code>
for std impl progress see rfc <code>&lt;https://github.com/rust-lang/rfcs/issues/2208&gt;</code>
replace this once that lands</div></li><li><div class="item-name"><a class="fn" href="fn.paths_refer_to_same_file.html" title="fn uucore::fs::paths_refer_to_same_file">paths_refer_to_same_file</a></div><div class="desc docblock-short">Checks if <code>p1</code> and <code>p2</code> are the same file.
If error happens when trying to get files’ metadata, returns false</div></li><li><div class="item-name"><a class="fn" href="fn.resolve_relative_path.html" title="fn uucore::fs::resolve_relative_path">resolve_relative_path</a></div><div class="desc docblock-short">resolve a relative path</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink