greptimedb/log_store/object_store_wal/io/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="Object store access for WAL objects: a deterministic key layout and conditional creates that make a retry of the same object a no-op."><title>log_store::object_store_wal::io - 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="log_store" 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 io</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../log_store/index.html">log_<wbr>store</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 io</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="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In log_<wbr>store::<wbr>object_<wbr>store_<wbr>wal</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">log_store</a>::<wbr><a href="../index.html">object_store_wal</a></div><h1>Module <span>io</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/log_store/object_store_wal/io.rs.html#15-573">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Object store access for WAL objects: a deterministic key layout and
conditional creates that make a retry of the same object a no-op.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.ListedObject.html" title="struct log_store::object_store_wal::io::ListedObject">Listed<wbr>Object</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>An object discovered by a LIST.</dd><dt><a class="struct" href="struct.ObjectStoreIo.html" title="struct log_store::object_store_wal::io::ObjectStoreIo">Object<wbr>Store<wbr>Io</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Reads and writes the WAL objects under one prefix.</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.PutResult.html" title="enum log_store::object_store_wal::io::PutResult">PutResult</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Outcome of a conditional create.</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.OBJECT_SEQ_WIDTH.html" title="constant log_store::object_store_wal::io::OBJECT_SEQ_WIDTH">OBJECT_<wbr>SEQ_<wbr>WIDTH</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Width of the zero-padded object sequence in an object key, wide enough for
<a href="https://doc.rust-lang.org/1.98.1/std/primitive.u64.html#associatedconstant.MAX" title="associated constant u64::MAX"><code>u64::MAX</code></a> so that lexicographic and numeric order agree.</dd><dt><a class="constant" href="constant.OBJECT_SUFFIX.html" title="constant log_store::object_store_wal::io::OBJECT_SUFFIX">OBJECT_<wbr>SUFFIX</a><span title="Restricted Visibility">&nbsp;🔒</span> </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.normalize_prefix.html" title="fn log_store::object_store_wal::io::normalize_prefix">normalize_<wbr>prefix</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.reports_existing_object.html" title="fn log_store::object_store_wal::io::reports_existing_object">reports_<wbr>existing_<wbr>object</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Returns true when a conditional create failed because the object exists.
Only the precondition failure says so: a store may report <code>AlreadyExists</code>
for an unrelated path, such as a parent that is a file.</dd></dl></section></div></main></body></html>