mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-10-12 23:12:28 +00:00
5 lines
7.3 KiB
HTML
5 lines
7.3 KiB
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 `ext` mod in crate `common_error`."><title>common_error::ext - 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_error" 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 ext</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_error/index.html">common_<wbr>error</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 ext</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate common_<wbr>error</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_error</a></div><h1>Module <span>ext</span> <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_error/ext.rs.html#15-386">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BoxedError.html" title="struct common_error::ext::BoxedError">Boxed<wbr>Error</a></dt><dd>An opaque boxed error based on errors that implement <a href="trait.ErrorExt.html" title="trait common_error::ext::ErrorExt">ErrorExt</a> trait.</dd><dt><a class="struct" href="struct.PlainError.html" title="struct common_error::ext::PlainError">Plain<wbr>Error</a></dt><dd>Error type with plain error message</dd><dt><a class="struct" href="struct.Whatever.html" title="struct common_error::ext::Whatever">Whatever</a></dt><dt><a class="struct" href="struct.WhateverSnafu.html" title="struct common_error::ext::WhateverSnafu">Whatever<wbr>Snafu</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>SNAFU context selector for the <code>Whatever</code> error</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.RetryHint.html" title="enum common_error::ext::RetryHint">Retry<wbr>Hint</a></dt><dd>Describes whether an error instance is safe and useful to retry.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.RETRY_HINT_NON_RETRYABLE.html" title="constant common_error::ext::RETRY_HINT_NON_RETRYABLE">RETRY_<wbr>HINT_<wbr>NON_<wbr>RETRYABLE</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.RETRY_HINT_RETRYABLE.html" title="constant common_error::ext::RETRY_HINT_RETRYABLE">RETRY_<wbr>HINT_<wbr>RETRYABLE</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ErrorExt.html" title="trait common_error::ext::ErrorExt">Error<wbr>Ext</a></dt><dd>Extension to <a href="https://doc.rust-lang.org/1.98.1/core/error/trait.Error.html" title="trait core::error::Error"><code>Error</code></a> in std.</dd><dt><a class="trait" href="trait.StackError.html" title="trait common_error::ext::StackError">Stack<wbr>Error</a></dt></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.error_chain_root.html" title="fn common_error::ext::error_chain_root">error_<wbr>chain_<wbr>root</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Returns the root cause of an error’s source chain, i.e. the last error
|
||
reachable via <a href="https://doc.rust-lang.org/1.98.1/core/error/trait.Error.html#method.source" title="method core::error::Error::source"><code>std::error::Error::source</code></a>. For an error without any
|
||
source the error itself is returned.</dd><dt><a class="fn" href="fn.retry_hint_from_io_error.html" title="fn common_error::ext::retry_hint_from_io_error">retry_<wbr>hint_<wbr>from_<wbr>io_<wbr>error</a></dt><dd>Converts a <a href="https://doc.rust-lang.org/1.98.1/core/io/error/struct.Error.html" title="struct core::io::error::Error"><code>std::io::Error</code></a> into a conservative <a href="enum.RetryHint.html" title="enum common_error::ext::RetryHint"><code>RetryHint</code></a>.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.WhateverResult.html" title="type common_error::ext::WhateverResult">Whatever<wbr>Result</a></dt><dd>A simple <a href="https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a> of which the error is convertible from <a href="trait.ErrorExt.html" title="trait common_error::ext::ErrorExt">ErrorExt</a> (which every GreptimeDB
|
||
error implements). Use this if you are tired of writing <code>unwrap</code>s in test codes, that you can
|
||
use the <code>?</code> on all GreptimeDB errors.</dd></dl></section></div></main></body></html> |