greptimedb/object_store/layers/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="API documentation for the Rust `layers` mod in crate `object_store`."><title>object_store::layers - 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="object_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 layers</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../object_store/index.html">object_<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 layers</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate object_<wbr>store</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">object_store</a></div><h1>Module <span>layers</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/object_store/layers.rs.html#15-54">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="hdfs/index.html" title="mod object_store::layers::hdfs">hdfs</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="mock/index.html" title="mod object_store::layers::mock">mock</a></dt><dt><a class="mod" href="prometheus/index.html" title="mod object_store::layers::prometheus">prometheus</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CapabilityOverrideLayer.html" title="struct object_store::layers::CapabilityOverrideLayer">Capability<wbr>Override<wbr>Layer</a></dt><dd>Layer for overriding an operator’s effective capability.</dd><dt><a class="struct" href="struct.ConcurrentLimitLayer.html" title="struct object_store::layers::ConcurrentLimitLayer">Concurrent<wbr>Limit<wbr>Layer</a></dt><dd><code>ConcurrentLimitLayer</code> controls how many concurrent requests OpenDAL can send
to a storage service.</dd><dt><a class="struct" href="struct.DefaultLoggingInterceptor.html" title="struct object_store::layers::DefaultLoggingInterceptor">Default<wbr>Logging<wbr>Interceptor</a></dt><dd>The DefaultLoggingInterceptor will log the message by the standard logging macro.</dd><dt><a class="struct" href="struct.DefaultRetryInterceptor.html" title="struct object_store::layers::DefaultRetryInterceptor">Default<wbr>Retry<wbr>Interceptor</a></dt><dd>The DefaultRetryInterceptor logs each retry error at warn level.</dd><dt><a class="struct" href="struct.HdfsCompatibilityLayer.html" title="struct object_store::layers::HdfsCompatibilityLayer">Hdfs<wbr>Compatibility<wbr>Layer</a></dt><dd>Adds atomic writes and streaming copies to the native HDFS backend.</dd><dt><a class="struct" href="struct.LoggingLayer.html" title="struct object_store::layers::LoggingLayer">Logging<wbr>Layer</a></dt><dd><code>LoggingLayer</code> records every operation with
<a href="https://docs.rs/log/">log</a>.</dd><dt><a class="struct" href="struct.PrometheusLayer.html" title="struct object_store::layers::PrometheusLayer">Prometheus<wbr>Layer</a></dt><dd><code>PrometheusLayer</code> records OpenDAL operation and HTTP fetch metrics with
<a href="https://docs.rs/prometheus">prometheus</a>.</dd><dt><a class="struct" href="struct.PrometheusLayerBuilder.html" title="struct object_store::layers::PrometheusLayerBuilder">Prometheus<wbr>Layer<wbr>Builder</a></dt><dd><a href="struct.PrometheusLayerBuilder.html" title="struct object_store::layers::PrometheusLayerBuilder"><code>PrometheusLayerBuilder</code></a> is a config builder to build a <a href="struct.PrometheusLayer.html" title="struct object_store::layers::PrometheusLayer"><code>PrometheusLayer</code></a>.</dd><dt><a class="struct" href="struct.RetryEvent.html" title="struct object_store::layers::RetryEvent">Retry<wbr>Event</a></dt><dd>Context passed to <a href="trait.RetryInterceptor.html" title="trait object_store::layers::RetryInterceptor"><code>RetryInterceptor</code></a> before each retry sleep.</dd><dt><a class="struct" href="struct.RetryLayer.html" title="struct object_store::layers::RetryLayer">Retry<wbr>Layer</a></dt><dd><code>RetryLayer</code> retries temporarily failed operations.</dd><dt><a class="struct" href="struct.SimulateLayer.html" title="struct object_store::layers::SimulateLayer">Simulate<wbr>Layer</a></dt><dd>Simulate missing capabilities for backends in a configurable way.</dd><dt><a class="struct" href="struct.TimeoutLayer.html" title="struct object_store::layers::TimeoutLayer">Timeout<wbr>Layer</a></dt><dd><code>TimeoutLayer</code> adds deadlines to operations so slow or stalled work cannot
hang indefinitely.</dd><dt><a class="struct" href="struct.TracingLayer.html" title="struct object_store::layers::TracingLayer">Tracing<wbr>Layer</a></dt><dd><code>TracingLayer</code> traces every operation with
<a href="https://docs.rs/tracing/">tracing</a>.</dd></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.ConcurrentLimitSemaphore.html" title="trait object_store::layers::ConcurrentLimitSemaphore">Concurrent<wbr>Limit<wbr>Semaphore</a></dt><dd>ConcurrentLimitSemaphore abstracts a semaphore-like concurrency primitive
that yields an owned permit released on drop.</dd><dt><a class="trait" href="trait.LoggingInterceptor.html" title="trait object_store::layers::LoggingInterceptor">Logging<wbr>Interceptor</a></dt><dd>LoggingInterceptor customizes log emission.</dd><dt><a class="trait" href="trait.RetryInterceptor.html" title="trait object_store::layers::RetryInterceptor">Retry<wbr>Interceptor</a></dt><dd>RetryInterceptor observes retry attempts before the retry sleep.</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.build_prometheus_metrics_layer.html" title="fn object_store::layers::build_prometheus_metrics_layer">build_<wbr>prometheus_<wbr>metrics_<wbr>layer</a></dt><dd>This logical tries to extract parent path from the object storage operation
the function also relies on assumption that the region path is built from
pattern <code>&lt;data|index&gt;/catalog/schema/table_id/...</code> OR <code>greptimedb/object_cache/&lt;read|write&gt;/...</code></dd></dl></section></div></main></body></html>