mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-10 23:32:55 +00:00
3 lines
7.0 KiB
HTML
3 lines
7.0 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 cache for files."><title>mito2::cache::file_cache - 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="mito2" 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 mod"><!--[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 file_cache</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../mito2/index.html">mito2</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="#">Module file_<wbr>cache</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><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In mito2::<wbr>cache</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">mito2</a>::<wbr><a href="../index.html">cache</a></div><h1>Module <span>file_<wbr>cache</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/cache/file_cache.rs.html#15-1084">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A cache for files.</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.DownloadTask.html" title="struct mito2::cache::file_cache::DownloadTask">Download<wbr>Task</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A task to download a file in the background.</dd><dt><a class="struct" href="struct.FileCache.html" title="struct mito2::cache::file_cache::FileCache">File<wbr>Cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A file cache manages files on local store and evict files based
|
|
on size.</dd><dt><a class="struct" href="struct.FileCacheInner.html" title="struct mito2::cache::file_cache::FileCacheInner">File<wbr>Cache<wbr>Inner</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Inner struct for FileCache that can be used in spawned tasks.</dd><dt><a class="struct" href="struct.IndexKey.html" title="struct mito2::cache::file_cache::IndexKey">Index<wbr>Key</a></dt><dd>Key of file cache index.</dd><dt><a class="struct" href="struct.IndexValue.html" title="struct mito2::cache::file_cache::IndexValue">Index<wbr>Value</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>An entity that describes the file in the file cache.</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.FileType.html" title="enum mito2::cache::file_cache::FileType">File<wbr>Type</a></dt><dd>Type of the file.</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.DEFAULT_INDEX_CACHE_PERCENT.html" title="constant mito2::cache::file_cache::DEFAULT_INDEX_CACHE_PERCENT">DEFAULT_<wbr>INDEX_<wbr>CACHE_<wbr>PERCENT</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Default percentage for index (puffin) cache (20% of total capacity).</dd><dt><a class="constant" href="constant.DOWNLOAD_TASK_CHANNEL_SIZE.html" title="constant mito2::cache::file_cache::DOWNLOAD_TASK_CHANNEL_SIZE">DOWNLOAD_<wbr>TASK_<wbr>CHANNEL_<wbr>SIZE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Channel capacity for background download tasks.</dd><dt><a class="constant" href="constant.FILE_DIR.html" title="constant mito2::cache::file_cache::FILE_DIR">FILE_<wbr>DIR</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Subdirectory of cached files for write.</dd><dt><a class="constant" href="constant.MIN_CACHE_CAPACITY.html" title="constant mito2::cache::file_cache::MIN_CACHE_CAPACITY">MIN_<wbr>CACHE_<wbr>CAPACITY</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Minimum capacity for each cache (512MB).</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.cache_file_path.html" title="fn mito2::cache::file_cache::cache_file_path">cache_<wbr>file_<wbr>path</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Generates the path to the cached file.</dd><dt><a class="fn" href="fn.parse_index_key.html" title="fn mito2::cache::file_cache::parse_index_key">parse_<wbr>index_<wbr>key</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Parse index key from the file name.</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.FileCacheRef.html" title="type mito2::cache::file_cache::FileCacheRef">File<wbr>Cache<wbr>Ref</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |