Skip to content

Commit 78fe746

Browse files
committed
docs: update javadocs & rustdocs
1 parent 5f57d77 commit 78fe746

File tree

5,377 files changed

+10762
-10762
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

5,377 files changed

+10762
-10762
lines changed

cedarling/doc/cedarling/enum.AuthorizeError.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
InvalidPrincipal(InvalidPrincipalError),
66
RequestValidation(RequestValidationError),
77
ValidateEntities(EntitiesError),
8-
EntitiesToJson(<a class="struct" href="https://docs.rs/serde_json/1.0.147/serde_json/error/struct.Error.html" title="struct serde_json::error::Error">Error</a>),
8+
EntitiesToJson(<a class="struct" href="https://docs.rs/serde_json/1.0.148/serde_json/error/struct.Error.html" title="struct serde_json::error::Error">Error</a>),
99
BuildContext(BuildContextError),
1010
IdTokenTrustMode(IdTokenTrustModeError),
1111
BuildEntity(BuildEntityError),
@@ -20,7 +20,7 @@
2020
</div><section id="variant.InvalidPrincipal" class="variant"><a href="#variant.InvalidPrincipal" class="anchor">§</a><h3 class="code-header">InvalidPrincipal(InvalidPrincipalError)</h3></section><div class="docblock"><p>Error encountered while creating [<code>cedar_policy::Request</code>] for entity principal</p>
2121
</div><section id="variant.RequestValidation" class="variant"><a href="#variant.RequestValidation" class="anchor">§</a><h3 class="code-header">RequestValidation(RequestValidationError)</h3></section><div class="docblock"><p>Error encountered while validating the Cedar request</p>
2222
</div><section id="variant.ValidateEntities" class="variant"><a href="#variant.ValidateEntities" class="anchor">§</a><h3 class="code-header">ValidateEntities(EntitiesError)</h3></section><div class="docblock"><p>Error encountered while checking if the Entities adhere to the schema</p>
23-
</div><section id="variant.EntitiesToJson" class="variant"><a href="#variant.EntitiesToJson" class="anchor">§</a><h3 class="code-header">EntitiesToJson(<a class="struct" href="https://docs.rs/serde_json/1.0.147/serde_json/error/struct.Error.html" title="struct serde_json::error::Error">Error</a>)</h3></section><div class="docblock"><p>Error encountered while parsing all entities to json for logging</p>
23+
</div><section id="variant.EntitiesToJson" class="variant"><a href="#variant.EntitiesToJson" class="anchor">§</a><h3 class="code-header">EntitiesToJson(<a class="struct" href="https://docs.rs/serde_json/1.0.148/serde_json/error/struct.Error.html" title="struct serde_json::error::Error">Error</a>)</h3></section><div class="docblock"><p>Error encountered while parsing all entities to json for logging</p>
2424
</div><section id="variant.BuildContext" class="variant"><a href="#variant.BuildContext" class="anchor">§</a><h3 class="code-header">BuildContext(BuildContextError)</h3></section><div class="docblock"><p>Error encountered while building the context for the request</p>
2525
</div><section id="variant.IdTokenTrustMode" class="variant"><a href="#variant.IdTokenTrustMode" class="anchor">§</a><h3 class="code-header">IdTokenTrustMode(IdTokenTrustModeError)</h3></section><div class="docblock"><p>Error encountered while building the context for the request</p>
2626
</div><section id="variant.BuildEntity" class="variant"><a href="#variant.BuildEntity" class="anchor">§</a><h3 class="code-header">BuildEntity(BuildEntityError)</h3></section><div class="docblock"><p>Error encountered while building Cedar Entities</p>

cedarling/doc/cedarling/enum.BootstrapConfigLoadingError.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

cedarling/doc/cedarling/struct.AuthorizeMultiIssuerRequest.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pub tokens: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="struct.TokenInput.html" title="struct cedarling::TokenInput">TokenInput</a>&gt;,
33
pub resource: <a class="struct" href="struct.EntityData.html" title="struct cedarling::EntityData">EntityData</a>,
44
pub action: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
5-
pub context: <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/serde_json/1.0.147/serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>&gt;,
5+
pub context: <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/serde_json/1.0.148/serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>&gt;,
66
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Multi-issuer authorization request</p>
77
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.tokens" class="structfield section-header"><a href="#structfield.tokens" class="anchor field">§</a><code>tokens: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="struct.TokenInput.html" title="struct cedarling::TokenInput">TokenInput</a>&gt;</code></span><div class="docblock"><p>Array of JWT tokens with explicit type mappings</p>
88
</div><span id="structfield.resource" class="structfield section-header"><a href="#structfield.resource" class="anchor field">§</a><code>resource: <a class="struct" href="struct.EntityData.html" title="struct cedarling::EntityData">EntityData</a></code></span><div class="docblock"><p>Resource being accessed (required for Cedar policy evaluation)</p>
99
</div><span id="structfield.action" class="structfield section-header"><a href="#structfield.action" class="anchor field">§</a><code>action: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>Action being performed (required for Cedar policy evaluation)</p>
10-
</div><span id="structfield.context" class="structfield section-header"><a href="#structfield.context" class="anchor field">§</a><code>context: <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/serde_json/1.0.147/serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>&gt;</code></span><div class="docblock"><p>Optional additional context for policy evaluation (JSON format)</p>
10+
</div><span id="structfield.context" class="structfield section-header"><a href="#structfield.context" class="anchor field">§</a><code>context: <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/serde_json/1.0.148/serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>&gt;</code></span><div class="docblock"><p>Optional additional context for policy evaluation (JSON format)</p>
1111
</div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AuthorizeMultiIssuerRequest" class="impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#161-201">Source</a><a href="#impl-AuthorizeMultiIssuerRequest" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.AuthorizeMultiIssuerRequest.html" title="struct cedarling::AuthorizeMultiIssuerRequest">AuthorizeMultiIssuerRequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#163-170">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(
1212
tokens: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="struct.TokenInput.html" title="struct cedarling::TokenInput">TokenInput</a>&gt;,
1313
resource: <a class="struct" href="struct.EntityData.html" title="struct cedarling::EntityData">EntityData</a>,
@@ -17,7 +17,7 @@
1717
tokens: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="struct.TokenInput.html" title="struct cedarling::TokenInput">TokenInput</a>&gt;,
1818
resource: <a class="struct" href="struct.EntityData.html" title="struct cedarling::EntityData">EntityData</a>,
1919
action: <a class="struct" href="https://doc.rust-lang.org/1.90.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
20-
context: <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/serde_json/1.0.147/serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>&gt;,
20+
context: <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://docs.rs/serde_json/1.0.148/serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>&gt;,
2121
) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a new AuthorizeMultiIssuerRequest with all fields</p>
2222
</div></details><details class="toggle method-toggle" open><summary><section id="method.validate" class="method"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#188-200">Source</a><h4 class="code-header">pub fn <a href="#method.validate" class="fn">validate</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.90.0/std/primitive.unit.html">()</a>, MultiIssuerValidationError&gt;</h4></section></summary><div class="docblock"><p>Basic validation of JSON fields</p>
2323
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-AuthorizeMultiIssuerRequest" class="impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#149">Source</a><a href="#impl-Clone-for-AuthorizeMultiIssuerRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.90.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.AuthorizeMultiIssuerRequest.html" title="struct cedarling::AuthorizeMultiIssuerRequest">AuthorizeMultiIssuerRequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#149">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.90.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.AuthorizeMultiIssuerRequest.html" title="struct cedarling::AuthorizeMultiIssuerRequest">AuthorizeMultiIssuerRequest</a></h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.90.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.90.0/src/core/clone.rs.html#213-215">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.90.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.90.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-AuthorizeMultiIssuerRequest" class="impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#149">Source</a><a href="#impl-Debug-for-AuthorizeMultiIssuerRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.90.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.AuthorizeMultiIssuerRequest.html" title="struct cedarling::AuthorizeMultiIssuerRequest">AuthorizeMultiIssuerRequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#149">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.90.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.90.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.90.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.90.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deserialize%3C'de%3E-for-AuthorizeMultiIssuerRequest" class="impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#149">Source</a><a href="#impl-Deserialize%3C'de%3E-for-AuthorizeMultiIssuerRequest" class="anchor">§</a><h3 class="code-header">impl&lt;'de&gt; <a class="trait" href="https://docs.rs/serde_core/1.0.228/serde_core/de/trait.Deserialize.html" title="trait serde_core::de::Deserialize">Deserialize</a>&lt;'de&gt; for <a class="struct" href="struct.AuthorizeMultiIssuerRequest.html" title="struct cedarling::AuthorizeMultiIssuerRequest">AuthorizeMultiIssuerRequest</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.deserialize" class="method trait-impl"><a class="src rightside" href="../src/cedarling/authz/request.rs.html#149">Source</a><a href="#method.deserialize" class="anchor">§</a><h4 class="code-header">fn <a href="https://docs.rs/serde_core/1.0.228/serde_core/de/trait.Deserialize.html#tymethod.deserialize" class="fn">deserialize</a>&lt;__D&gt;(__deserializer: __D) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.90.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, __D::<a class="associatedtype" href="https://docs.rs/serde_core/1.0.228/serde_core/de/trait.Deserializer.html#associatedtype.Error" title="type serde_core::de::Deserializer::Error">Error</a>&gt;<div class="where">where

0 commit comments

Comments
 (0)