Files
greptimedb/object_store/util/fn.normalize_dir.html
2025-12-24 05:00:45 +00:00

16 lines
4.7 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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="Modified from the `opendal::raw::normalize_root`"><title>normalize_dir in object_store::util - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="object_store" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">normalize_dir</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../object_store/index.html">object_<wbr>store</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">normalize_<wbr>dir</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#the-different" title="The different">The different</a></li><li><a href="#normalize-rules" title="Normalize Rules">Normalize Rules</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In object_<wbr>store::<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">object_store</a>::<wbr><a href="index.html">util</a></div><h1>Function <span class="fn">normalize_<wbr>dir</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/object_store/util.rs.html#63-77">Source</a> </span></div><pre class="rust item-decl"><code>pub fn normalize_dir(v: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Modified from the <code>opendal::raw::normalize_root</code></p>
<h2 id="the-different"><a class="doc-anchor" href="#the-different">§</a>The different</h2>
<p>It doesnt always append <code>/</code> ahead of the path,
It only keeps <code>/</code> ahead if the original path starts with <code>/</code>.</p>
<p>Make sure the directory is normalized to style like <code>abc/def/</code>.</p>
<h2 id="normalize-rules"><a class="doc-anchor" href="#normalize-rules">§</a>Normalize Rules</h2>
<ul>
<li>All whitespace will be trimmed: <code>abc/def</code> =&gt; <code>abc/def</code></li>
<li>All leading / will be trimmed: <code>///abc</code> =&gt; <code>abc</code></li>
<li>Internal // will be replaced by /: <code>abc///def</code> =&gt; <code>abc/def</code></li>
<li>Empty path will be <code>/</code>: `` =&gt; <code>/</code></li>
<li><strong>(Removed❗)</strong> <del>Add leading <code>/</code> if not starts with: <code>abc/</code> =&gt; <code>/abc/</code></del></li>
<li>Add trailing <code>/</code> if not ends with: <code>/abc</code> =&gt; <code>/abc/</code></li>
</ul>
<p>Finally, we will got path like <code>/path/to/root/</code>.</p>
</div></details></section></div></main></body></html>