Skip to content

Commit

Permalink
deploy: 9048298
Browse files Browse the repository at this point in the history
  • Loading branch information
@ramfox
ramfox committed Dec 17, 2024
1 parent adafa37 commit 5487865
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 15 deletions.
2 changes: 1 addition & 1 deletion pr/23/docs/iroh_docs/sync/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!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 for iroh-docs replicas"><title>iroh_docs::sync - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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-dbdb5eec.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="iroh_docs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (d10a6823f 2024-11-29)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.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 mod"><!--[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="../../iroh_docs/index.html">iroh_<wbr>docs</a><span class="version">0.29.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module sync</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="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate iroh_<wbr>docs</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"><span class="rustdoc-breadcrumbs"><a href="../index.html">iroh_docs</a></span><h1>Module <span>sync</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/iroh_docs/sync.rs.html#1-2548">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>API for iroh-docs replicas</p>
<!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 for iroh-docs replicas"><title>iroh_docs::sync - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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-dbdb5eec.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="iroh_docs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (d10a6823f 2024-11-29)" data-channel="nightly" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.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 mod"><!--[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="../../iroh_docs/index.html">iroh_<wbr>docs</a><span class="version">0.29.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module sync</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="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate iroh_<wbr>docs</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"><span class="rustdoc-breadcrumbs"><a href="../index.html">iroh_docs</a></span><h1>Module <span>sync</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/iroh_docs/sync.rs.html#1-2560">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>API for iroh-docs replicas</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AuthorHeads.html" title="struct iroh_docs::sync::AuthorHeads">Author<wbr>Heads</a></div><div class="desc docblock-short">Timestamps of the latest entry for each author.</div></li><li><div class="item-name"><a class="struct" href="struct.Entry.html" title="struct iroh_docs::sync::Entry">Entry</a></div><div class="desc docblock-short">A single entry in a <a href="struct.Replica.html" title="struct iroh_docs::sync::Replica"><code>Replica</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.EntrySignature.html" title="struct iroh_docs::sync::EntrySignature">Entry<wbr>Signature</a></div><div class="desc docblock-short">Signature over an entry.</div></li><li><div class="item-name"><a class="struct" href="struct.ReadOnly.html" title="struct iroh_docs::sync::ReadOnly">Read<wbr>Only</a></div><div class="desc docblock-short">Error that occurs trying to access the <a href="../struct.NamespaceSecret.html" title="struct iroh_docs::NamespaceSecret"><code>NamespaceSecret</code></a> of a read-only <a href="enum.Capability.html" title="enum iroh_docs::sync::Capability"><code>Capability</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Record.html" title="struct iroh_docs::sync::Record">Record</a></div><div class="desc docblock-short">The data part of an entry in a <a href="struct.Replica.html" title="struct iroh_docs::sync::Replica"><code>Replica</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RecordIdentifier.html" title="struct iroh_docs::sync::RecordIdentifier">Record<wbr>Identifier</a></div><div class="desc docblock-short">The identifier of a record.</div></li><li><div class="item-name"><a class="struct" href="struct.Replica.html" title="struct iroh_docs::sync::Replica">Replica</a></div><div class="desc docblock-short">Local representation of a mutable, synchronizable key-value store.</div></li><li><div class="item-name"><a class="struct" href="struct.ReplicaInfo.html" title="struct iroh_docs::sync::ReplicaInfo">Replica<wbr>Info</a></div><div class="desc docblock-short">In memory information about an open replica.</div></li><li><div class="item-name"><a class="struct" href="struct.SignedEntry.html" title="struct iroh_docs::sync::SignedEntry">Signed<wbr>Entry</a></div><div class="desc docblock-short">A signed entry.</div></li><li><div class="item-name"><a class="struct" href="struct.SyncOutcome.html" title="struct iroh_docs::sync::SyncOutcome">Sync<wbr>Outcome</a></div><div class="desc docblock-short">Outcome of a sync operation.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Capability.html" title="enum iroh_docs::sync::Capability">Capability</a></div><div class="desc docblock-short">The capability of the namespace.</div></li><li><div class="item-name"><a class="enum" href="enum.CapabilityError.html" title="enum iroh_docs::sync::CapabilityError">Capability<wbr>Error</a></div><div class="desc docblock-short">Errors for capability operations</div></li><li><div class="item-name"><a class="enum" href="enum.CapabilityKind.html" title="enum iroh_docs::sync::CapabilityKind">Capability<wbr>Kind</a></div><div class="desc docblock-short">Kind of capability of the namespace.</div></li><li><div class="item-name"><a class="enum" href="enum.ContentStatus.html" title="enum iroh_docs::sync::ContentStatus">Content<wbr>Status</a></div><div class="desc docblock-short">Whether the content status is available on a node.</div></li><li><div class="item-name"><a class="enum" href="enum.Event.html" title="enum iroh_docs::sync::Event">Event</a></div><div class="desc docblock-short">Event emitted by sync when entries are added.</div></li><li><div class="item-name"><a class="enum" href="enum.InsertError.html" title="enum iroh_docs::sync::InsertError">Insert<wbr>Error</a></div><div class="desc docblock-short">Error emitted when inserting entries into a <a href="struct.Replica.html" title="struct iroh_docs::sync::Replica"><code>Replica</code></a> failed</div></li><li><div class="item-name"><a class="enum" href="enum.InsertOrigin.html" title="enum iroh_docs::sync::InsertOrigin">Insert<wbr>Origin</a></div><div class="desc docblock-short">Whether an entry was inserted locally or by a remote peer.</div></li><li><div class="item-name"><a class="enum" href="enum.ValidationFailure.html" title="enum iroh_docs::sync::ValidationFailure">Validation<wbr>Failure</a></div><div class="desc docblock-short">Reason why entry validation failed</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.MAX_TIMESTAMP_FUTURE_SHIFT.html" title="constant iroh_docs::sync::MAX_TIMESTAMP_FUTURE_SHIFT">MAX_<wbr>TIMESTAMP_<wbr>FUTURE_<wbr>SHIFT</a></div><div class="desc docblock-short">Max time in the future from our wall clock time that we accept entries for.
Value is 10 minutes.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ContentStatusCallback.html" title="type iroh_docs::sync::ContentStatusCallback">Content<wbr>Status<wbr>Callback</a></div><div class="desc docblock-short">Callback that may be set on a replica to determine the availability status for a content hash.</div></li><li><div class="item-name"><a class="type" href="type.PeerIdBytes.html" title="type iroh_docs::sync::PeerIdBytes">Peer<wbr>IdBytes</a></div><div class="desc docblock-short">Byte representation of a <code>PeerId</code> from <code>iroh-net</code>.</div></li><li><div class="item-name"><a class="type" href="type.ProtocolMessage.html" title="type iroh_docs::sync::ProtocolMessage">Protocol<wbr>Message</a></div><div class="desc docblock-short">Protocol message for the set reconciliation protocol.</div></li></ul></section></div></main></body></html>
6 changes: 3 additions & 3 deletions pr/23/docs/src/iroh_docs/store/fs.rs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2265,7 +2265,7 @@
</span>.collect::&lt;<span class="prelude-ty">Result</span>&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;&gt;()<span class="question-mark">?</span>;

<span class="macro">assert_eq!</span>(expected, actual);

store.flush()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}

Expand All @@ -2282,8 +2282,8 @@
}

<span class="comment">// TODO: write test checking that the indexing is done correctly

</span><span class="prelude-val">Ok</span>(())
</span>store.flush()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
}
</code></pre></div></section></main></body></html>
Loading

0 comments on commit 5487865

Please sign in to comment.