20 lines
8.4 KiB
HTML
20 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="Trait defining a simple key‑value metadata store."><title>MetadataStore in ucxl - 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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-916cea96.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ucxl" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0 (17067e9ac 2025-05-09)" data-channel="1.87.0" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="../static.files/storage-82c7156e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-fb8c74a8.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ucxl/index.html">ucxl</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Metadata<wbr>Store</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get" title="get">get</a></li><li><a href="#tymethod.set" title="set">set</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.remove" title="remove">remove</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate ucxl</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">ucxl</a></div><h1>Trait <span class="trait">MetadataStore</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/ucxl/lib.rs.html#217-226">Source</a> </span></div><pre class="rust item-decl"><code>pub trait MetadataStore {
|
||
// Required methods
|
||
fn <a href="#tymethod.get" class="fn">get</a>(&self, path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.87.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="https://doc.rust-lang.org/1.87.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.set" class="fn">set</a>(&mut self, path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>, metadata: <a class="struct" href="https://doc.rust-lang.org/1.87.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>);
|
||
|
||
// Provided method
|
||
fn <a href="#method.remove" class="fn">remove</a>(&mut self, path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.87.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.87.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>> { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait defining a simple key‑value metadata store.</p>
|
||
<p><strong>What</strong>: Provides read, write and removal operations for associating a
|
||
string of metadata with a file‑system path.</p>
|
||
<p><strong>How</strong>: The trait abstracts over concrete storage implementations –
|
||
currently an in‑memory <code>HashMap</code> – allowing callers to depend on the trait
|
||
rather than a specific type.</p>
|
||
<p><strong>Why</strong>: CHORUS needs a lightweight way to attach auxiliary information to
|
||
files without persisting to a database; the trait makes it easy to swap in a
|
||
persistent backend later if required.</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.get" class="method"><a class="src rightside" href="../src/ucxl/lib.rs.html#219">Source</a><h4 class="code-header">fn <a href="#tymethod.get" class="fn">get</a>(&self, path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.87.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="https://doc.rust-lang.org/1.87.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></h4></section></summary><div class="docblock"><p>Retrieves the metadata for <code>path</code> if it exists.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set" class="method"><a class="src rightside" href="../src/ucxl/lib.rs.html#221">Source</a><h4 class="code-header">fn <a href="#tymethod.set" class="fn">set</a>(&mut self, path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>, metadata: <a class="struct" href="https://doc.rust-lang.org/1.87.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</h4></section></summary><div class="docblock"><p>Stores <code>metadata</code> for <code>path</code>, overwriting any existing value.</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.remove" class="method"><a class="src rightside" href="../src/ucxl/lib.rs.html#223-225">Source</a><h4 class="code-header">fn <a href="#method.remove" class="fn">remove</a>(&mut self, path: &<a class="primitive" href="https://doc.rust-lang.org/1.87.0/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.87.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.87.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></h4></section></summary><div class="docblock"><p>Removes the metadata entry for <code>path</code>, returning the old value if any.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-MetadataStore-for-InMemoryMetadataStore" class="impl"><a class="src rightside" href="../src/ucxl/lib.rs.html#257-267">Source</a><a href="#impl-MetadataStore-for-InMemoryMetadataStore" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.MetadataStore.html" title="trait ucxl::MetadataStore">MetadataStore</a> for <a class="struct" href="struct.InMemoryMetadataStore.html" title="struct ucxl::InMemoryMetadataStore">InMemoryMetadataStore</a></h3></section></div><script src="../trait.impl/ucxl/trait.MetadataStore.js" async></script></section></div></main></body></html> |