mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-06-03 13:50:40 +00:00
28 lines
8.4 KiB
HTML
28 lines
8.4 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="A worker to delete files in background."><title>FilePurger in mito2::sst::file_purger - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="mito2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 trait"><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="#">FilePurger</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../mito2/index.html">mito2</a><span class="version">1.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">File<wbr>Purger</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.remove_file" title="remove_file">remove_file</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.new_file" title="new_file">new_file</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In mito2::<wbr>sst::<wbr>file_<wbr>purger</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">mito2</a>::<wbr><a href="../index.html">sst</a>::<wbr><a href="index.html">file_purger</a></div><h1>Trait <span class="trait">File<wbr>Purger</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/mito2/sst/file_purger.rs.html#29-42">Source</a> </span></div><pre class="rust item-decl"><code>pub trait FilePurger:
|
|
<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>
|
|
+ <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
|
// Required method
|
|
fn <a href="#tymethod.remove_file" class="fn">remove_file</a>(
|
|
&self,
|
|
file_meta: <a class="struct" href="../file/struct.FileMeta.html" title="struct mito2::sst::file::FileMeta">FileMeta</a>,
|
|
is_delete: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|
index_outdated: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|
);
|
|
|
|
// Provided method
|
|
fn <a href="#method.new_file" class="fn">new_file</a>(&self, _: &<a class="struct" href="../file/struct.FileMeta.html" title="struct mito2::sst::file::FileMeta">FileMeta</a>) { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A worker to delete files in background.</p>
|
|
</div></details><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.remove_file" class="method"><a class="src rightside" href="../../../src/mito2/sst/file_purger.rs.html#34">Source</a><h4 class="code-header">fn <a href="#tymethod.remove_file" class="fn">remove_file</a>(
|
|
&self,
|
|
file_meta: <a class="struct" href="../file/struct.FileMeta.html" title="struct mito2::sst::file::FileMeta">FileMeta</a>,
|
|
is_delete: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|
index_outdated: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
|
)</h4></section></summary><div class="docblock"><p>Send a request to remove the file.
|
|
If <code>is_delete</code> is true, the file will be deleted from the storage.
|
|
Otherwise, only the reference will be removed.
|
|
If <code>index_outdated</code> is true, the index file will be deleted regardless of <code>is_delete</code>.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.new_file" class="method"><a class="src rightside" href="../../../src/mito2/sst/file_purger.rs.html#39-41">Source</a><h4 class="code-header">fn <a href="#method.new_file" class="fn">new_file</a>(&self, _: &<a class="struct" href="../file/struct.FileMeta.html" title="struct mito2::sst::file::FileMeta">FileMeta</a>)</h4></section></summary><div class="docblock"><p>Notify the purger of a new file created.
|
|
This is useful for object store based storage, where we need to track the file references
|
|
The default implementation is a no-op.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><div class="negative-marker"></div><section id="impl-FilePurger-for-LocalFilePurger" class="impl"><a class="src rightside" href="../../../src/mito2/sst/file_purger.rs.html#177-185">Source</a><a href="#impl-FilePurger-for-LocalFilePurger" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FilePurger.html" title="trait mito2::sst::file_purger::FilePurger">FilePurger</a> for <a class="struct" href="struct.LocalFilePurger.html" title="struct mito2::sst::file_purger::LocalFilePurger">LocalFilePurger</a></h3></section><section id="impl-FilePurger-for-NoopFilePurger" class="impl"><a class="src rightside" href="../../../src/mito2/sst/file_purger.rs.html#50-54">Source</a><a href="#impl-FilePurger-for-NoopFilePurger" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FilePurger.html" title="trait mito2::sst::file_purger::FilePurger">FilePurger</a> for <a class="struct" href="struct.NoopFilePurger.html" title="struct mito2::sst::file_purger::NoopFilePurger">NoopFilePurger</a></h3></section><section id="impl-FilePurger-for-ObjectStoreFilePurger" class="impl"><a class="src rightside" href="../../../src/mito2/sst/file_purger.rs.html#192-204">Source</a><a href="#impl-FilePurger-for-ObjectStoreFilePurger" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FilePurger.html" title="trait mito2::sst::file_purger::FilePurger">FilePurger</a> for <a class="struct" href="struct.ObjectStoreFilePurger.html" title="struct mito2::sst::file_purger::ObjectStoreFilePurger">ObjectStoreFilePurger</a></h3></section></div><script src="../../../trait.impl/mito2/sst/file_purger/trait.FilePurger.js" async></script></section></div></main></body></html> |