greptimedb/common_meta/kv_backend/util/index.html

<!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 `util` mod in crate `common_meta`."><title>common_meta::kv_backend::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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="common_meta" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.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 mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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="#">Module util</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../common_meta/index.html">common_<wbr>meta</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module util</a></h2><h3><a href="#constants">Module Items</a></h3><ul class="block"><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In common_<wbr>meta::<wbr>kv_<wbr>backend</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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">common_meta</a>::<wbr><a href="../index.html">kv_backend</a></div><h1>Module <span>util</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/common_meta/kv_backend/util.rs.html#15-378">Source</a> </span></div><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.REDACTED.html" title="constant common_meta::kv_backend::util::REDACTED">REDACTED</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Placeholder substituted for any password found in a connection string.</dd><dt><a class="constant" href="constant.REDACTED_CONNECTION_STRING.html" title="constant common_meta::kv_backend::util::REDACTED_CONNECTION_STRING">REDACTED_<wbr>CONNECTION_<wbr>STRING</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Substituted for a whole connection string that cannot be safely sanitized.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.is_keyword_at.html" title="fn common_meta::kv_backend::util::is_keyword_at">is_<wbr>keyword_<wbr>at</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>True if <code>keyword</code> starts at byte <code>i</code> preceded by a keyword boundary. In
addition to valid libpq whitespace separators, <code>;</code> and <code>&amp;</code> are treated as
conservative boundaries so malformed DSNs cannot leak credentials. Other
punctuation, such as the <code>=</code> in <code>application_name=password=x</code>, is handled by
the fail-closed path.</dd><dt><a class="fn" href="fn.is_uri_like.html" title="fn common_meta::kv_backend::util::is_uri_like">is_<wbr>uri_<wbr>like</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>True if <code>s</code>, ignoring leading whitespace, begins with a valid URI scheme
followed by <code>://</code> (<code>scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )</code>).
Leading whitespace (including Unicode, e.g. U+2003) does not stop a value from
being a URI, so it is trimmed first; a bare <code>contains("://")</code> would instead
misfire on a <code>://</code> inside a keyword value.</dd><dt><a class="fn" href="fn.keyword_matches_at.html" title="fn common_meta::kv_backend::util::keyword_matches_at">keyword_<wbr>matches_<wbr>at</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.redact_keyword_password.html" title="fn common_meta::kv_backend::util::redact_keyword_password">redact_<wbr>keyword_<wbr>password</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Redacts <code>password</code> values in a keyword string. A standalone, case-insensitive
<code>password</code> assignment outside a recognized keyword boundary causes the whole
string to be redacted, since another option’s value may otherwise retain it.
Keys are separated by Unicode whitespace; a value is single/double quoted or
runs to the next unescaped whitespace, with <code>\</code> escaping the next character.</dd><dt><a class="fn" href="fn.redact_url.html" title="fn common_meta::kv_backend::util::redact_url">redact_<wbr>url</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Redacts the userinfo password and any <code>password</code> query parameter of a parsed URL.</dd><dt><a class="fn" href="fn.sanitize_connection_string.html" title="fn common_meta::kv_backend::util::sanitize_connection_string">sanitize_<wbr>connection_<wbr>string</a></dt><dd>Removes sensitive information (passwords) from a connection string before it
is logged.</dd><dt><a class="fn" href="fn.skip_value.html" title="fn common_meta::kv_backend::util::skip_value">skip_<wbr>value</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns the byte index just past a keyword value beginning at <code>start</code>.</dd><dt><a class="fn" href="fn.skip_ws.html" title="fn common_meta::kv_backend::util::skip_ws">skip_ws</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>