mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-14 17:23:09 +00:00
129 lines
33 KiB
HTML
129 lines
33 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="`LogStore` serves as a Write-Ahead-Log for storage engine."><title>LogStore in store_api::logstore - 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="store_api" 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 trait"><!--[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="#">LogStore</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">LogStore</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.append_batch" title="append_batch">append_batch</a></li><li><a href="#tymethod.create_namespace" title="create_namespace">create_namespace</a></li><li><a href="#tymethod.delete_namespace" title="delete_namespace">delete_namespace</a></li><li><a href="#tymethod.entry" title="entry">entry</a></li><li><a href="#tymethod.latest_entry_id" title="latest_entry_id">latest_entry_id</a></li><li><a href="#tymethod.list_namespaces" title="list_namespaces">list_namespaces</a></li><li><a href="#tymethod.obsolete" title="obsolete">obsolete</a></li><li><a href="#tymethod.read" title="read">read</a></li><li><a href="#tymethod.stop" title="stop">stop</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In store_<wbr>api::<wbr>logstore</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">store_api</a>::<wbr><a href="index.html">logstore</a></div><h1>Trait <span class="trait">LogStore</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/store_api/logstore.rs.html#51-100">Source</a> </span></div><pre class="rust item-decl"><code>pub trait LogStore:
|
|
<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>
|
|
+ 'static
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: ErrorExt + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.stop" class="fn">stop</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.append_batch" class="fn">append_batch</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
entries: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="entry/enum.Entry.html" title="enum store_api::logstore::entry::Entry">Entry</a>>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.AppendBatchResponse.html" title="struct store_api::logstore::AppendBatchResponse">AppendBatchResponse</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.read" class="fn">read</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
provider: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
id: <a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>,
|
|
index: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.WalIndex.html" title="struct store_api::logstore::WalIndex">WalIndex</a>>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="type.SendableEntryStream.html" title="type store_api::logstore::SendableEntryStream">SendableEntryStream</a><'static, <a class="enum" href="entry/enum.Entry.html" title="enum store_api::logstore::entry::Entry">Entry</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.create_namespace" class="fn">create_namespace</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
ns: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.delete_namespace" class="fn">delete_namespace</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
ns: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.list_namespaces" class="fn">list_namespaces</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.obsolete" class="fn">obsolete</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
provider: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
region_id: <a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>,
|
|
entry_id: <a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
|
<span class="where">where Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.entry" class="fn">entry</a>(
|
|
&self,
|
|
data: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>,
|
|
entry_id: <a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>,
|
|
region_id: <a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>,
|
|
provider: &<a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="entry/enum.Entry.html" title="enum store_api::logstore::entry::Entry">Entry</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.latest_entry_id" class="fn">latest_entry_id</a>(
|
|
&self,
|
|
provider: &<a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>LogStore</code> serves as a Write-Ahead-Log for storage engine.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#52">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: ErrorExt + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static</h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.stop" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#55">Source</a><h4 class="code-header">fn <a href="#tymethod.stop" class="fn">stop</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Stops components of the logstore.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.append_batch" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#59">Source</a><h4 class="code-header">fn <a href="#tymethod.append_batch" class="fn">append_batch</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
entries: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="entry/enum.Entry.html" title="enum store_api::logstore::entry::Entry">Entry</a>>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.AppendBatchResponse.html" title="struct store_api::logstore::AppendBatchResponse">AppendBatchResponse</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Appends a batch of entries and returns a response containing a map where the key is a region id
|
|
while the value is the id of the last successfully written entry of the region.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.read" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#63-68">Source</a><h4 class="code-header">fn <a href="#tymethod.read" class="fn">read</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
provider: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
id: <a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>,
|
|
index: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.WalIndex.html" title="struct store_api::logstore::WalIndex">WalIndex</a>>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="type.SendableEntryStream.html" title="type store_api::logstore::SendableEntryStream">SendableEntryStream</a><'static, <a class="enum" href="entry/enum.Entry.html" title="enum store_api::logstore::entry::Entry">Entry</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Creates a new <code>EntryStream</code> to asynchronously generates <code>Entry</code> with ids
|
|
starting from <code>id</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.create_namespace" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#71">Source</a><h4 class="code-header">fn <a href="#tymethod.create_namespace" class="fn">create_namespace</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
ns: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Creates a new <code>Namespace</code> from the given ref.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.delete_namespace" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#74">Source</a><h4 class="code-header">fn <a href="#tymethod.delete_namespace" class="fn">delete_namespace</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
ns: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Deletes an existing <code>Namespace</code> specified by the given ref.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.list_namespaces" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#77">Source</a><h4 class="code-header">fn <a href="#tymethod.list_namespaces" class="fn">list_namespaces</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Lists all existing namespaces.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.obsolete" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#82-87">Source</a><h4 class="code-header">fn <a href="#tymethod.obsolete" class="fn">obsolete</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
provider: &'life1 <a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
region_id: <a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>,
|
|
entry_id: <a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>,
|
|
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
|
Self: 'async_trait,
|
|
'life0: 'async_trait,
|
|
'life1: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Marks all entries with ids <code><=entry_id</code> of the given <code>namespace</code> as obsolete,
|
|
so that the log store can safely delete those entries. This method does not guarantee
|
|
that the obsolete entries are deleted immediately.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.entry" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#90-96">Source</a><h4 class="code-header">fn <a href="#tymethod.entry" class="fn">entry</a>(
|
|
&self,
|
|
data: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>,
|
|
entry_id: <a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>,
|
|
region_id: <a class="struct" href="../storage/struct.RegionId.html" title="struct store_api::storage::RegionId">RegionId</a>,
|
|
provider: &<a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="entry/enum.Entry.html" title="enum store_api::logstore::entry::Entry">Entry</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>></h4></section></summary><div class="docblock"><p>Makes an entry instance of the associated Entry type</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.latest_entry_id" class="method"><a class="src rightside" href="../../src/store_api/logstore.rs.html#99">Source</a><h4 class="code-header">fn <a href="#tymethod.latest_entry_id" class="fn">latest_entry_id</a>(&self, provider: &<a class="enum" href="provider/enum.Provider.html" title="enum store_api::logstore::provider::Provider">Provider</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="type" href="entry/type.Id.html" title="type store_api::logstore::entry::Id">EntryId</a>, Self::<a class="associatedtype" href="trait.LogStore.html#associatedtype.Error" title="type store_api::logstore::LogStore::Error">Error</a>></h4></section></summary><div class="docblock"><p>Returns the latest entry id in the log store.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/store_api/logstore/trait.LogStore.js" async></script></section></div></main></body></html> |