Skip to content

Commit 57f77ce

Browse files
committed
docs: update javadocs & rustdocs
1 parent b5f21ab commit 57f77ce

File tree

5,382 files changed

+16950
-15994
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,382 files changed

+16950
-15994
lines changed

cedarling/doc/src-files.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cedarling/doc/src/cedarling/authz/mod.rs.html

Lines changed: 836 additions & 825 deletions
Large diffs are not rendered by default.

cedarling/doc/src/cedarling/common/default_entities.rs.html

Lines changed: 1393 additions & 0 deletions
Large diffs are not rendered by default.

cedarling/doc/src/cedarling/common/default_entities_limits.rs.html

Lines changed: 252 additions & 0 deletions
Large diffs are not rendered by default.

cedarling/doc/src/cedarling/common/mod.rs.html

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,51 +9,53 @@
99
<a href=#9 id=9 data-nosnippet>9</a>
1010
<a href=#10 id=10 data-nosnippet>10</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>app_types;
1111
<a href=#11 id=11 data-nosnippet>11</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>cedar_schema;
12-
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>json_rules;
13-
<a href=#13 id=13 data-nosnippet>13</a>
14-
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">pub mod </span>issuer_utils;
15-
<a href=#15 id=15 data-nosnippet>15</a><span class="kw">pub mod </span>policy_store;
16-
<a href=#16 id=16 data-nosnippet>16</a>
17-
<a href=#17 id=17 data-nosnippet>17</a><span class="doccomment">/// Used for decoding the policy and schema metadata
18-
<a href=#18 id=18 data-nosnippet>18</a></span><span class="attr">#[derive(Debug, Copy, Clone, PartialEq, serde::Deserialize)]
19-
<a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">enum </span>Encoding {
20-
<a href=#20 id=20 data-nosnippet>20</a> <span class="doccomment">/// indicates that the related value is base64 encoded
21-
<a href=#21 id=21 data-nosnippet>21</a> </span><span class="attr">#[serde(rename = <span class="string">"base64"</span>)]
22-
<a href=#22 id=22 data-nosnippet>22</a> </span>Base64,
23-
<a href=#23 id=23 data-nosnippet>23</a>
24-
<a href=#24 id=24 data-nosnippet>24</a> <span class="doccomment">/// indicates that the related value is not encoded, ie it's just a plain string
25-
<a href=#25 id=25 data-nosnippet>25</a> </span><span class="attr">#[serde(rename = <span class="string">"none"</span>)]
26-
<a href=#26 id=26 data-nosnippet>26</a> </span><span class="prelude-val">None</span>,
27-
<a href=#27 id=27 data-nosnippet>27</a>}
28-
<a href=#28 id=28 data-nosnippet>28</a>
29-
<a href=#29 id=29 data-nosnippet>29</a><span class="doccomment">/// Used for decoding the policy and schema metadata
30-
<a href=#30 id=30 data-nosnippet>30</a></span><span class="attr">#[derive(Debug, Clone, serde::Deserialize)]
31-
<a href=#31 id=31 data-nosnippet>31</a></span><span class="kw">enum </span>ContentType {
32-
<a href=#32 id=32 data-nosnippet>32</a> <span class="doccomment">/// indicates that the related value is in the cedar policy / schema language
33-
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="attr">#[serde(rename = <span class="string">"cedar"</span>)]
34-
<a href=#34 id=34 data-nosnippet>34</a> </span>Cedar,
35-
<a href=#35 id=35 data-nosnippet>35</a>
36-
<a href=#36 id=36 data-nosnippet>36</a> <span class="doccomment">/// indicates that the related value is in the json representation of the cedar policy / schema language
37-
<a href=#37 id=37 data-nosnippet>37</a> </span><span class="attr">#[serde(rename = <span class="string">"cedar-json"</span>)]
38-
<a href=#38 id=38 data-nosnippet>38</a> </span>CedarJson,
39-
<a href=#39 id=39 data-nosnippet>39</a>}
40-
<a href=#40 id=40 data-nosnippet>40</a>
41-
<a href=#41 id=41 data-nosnippet>41</a><span class="comment">// Implement the trait for all iterators over Result&lt;T, E&gt;
42-
<a href=#42 id=42 data-nosnippet>42</a></span><span class="kw">impl</span>&lt;T, E, I&gt; PartitionResult&lt;T, E&gt; <span class="kw">for </span>I <span class="kw">where </span>I: Iterator&lt;Item = <span class="prelude-ty">Result</span>&lt;T, E&gt;&gt; {}
43-
<a href=#43 id=43 data-nosnippet>43</a>
44-
<a href=#44 id=44 data-nosnippet>44</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>PartitionResult&lt;T, E&gt;: Iterator&lt;Item = <span class="prelude-ty">Result</span>&lt;T, E&gt;&gt; + Sized {
45-
<a href=#45 id=45 data-nosnippet>45</a> <span class="doccomment">/// Splits an iterator of `Result&lt;T, E&gt;` into two separate `Vec`s:
46-
<a href=#46 id=46 data-nosnippet>46</a> /// one containing all `Ok(T)` values and the other containing all `Err(E)` values.
47-
<a href=#47 id=47 data-nosnippet>47</a> </span><span class="kw">fn </span>partition_result(<span class="self">self</span>) -&gt; (Vec&lt;T&gt;, Vec&lt;E&gt;) {
48-
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span><span class="kw-2">mut </span>ok = Vec::new();
49-
<a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let </span><span class="kw-2">mut </span>errs = Vec::new();
50-
<a href=#50 id=50 data-nosnippet>50</a>
51-
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">for </span>r <span class="kw">in </span><span class="self">self </span>{
52-
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">match </span>r {
53-
<a href=#53 id=53 data-nosnippet>53</a> <span class="prelude-val">Ok</span>(v) =&gt; ok.push(v),
54-
<a href=#54 id=54 data-nosnippet>54</a> <span class="prelude-val">Err</span>(e) =&gt; errs.push(e),
55-
<a href=#55 id=55 data-nosnippet>55</a> }
56-
<a href=#56 id=56 data-nosnippet>56</a> }
57-
<a href=#57 id=57 data-nosnippet>57</a> (ok, errs)
58-
<a href=#58 id=58 data-nosnippet>58</a> }
59-
<a href=#59 id=59 data-nosnippet>59</a>}</code></pre></div></section></main></body></html>
12+
<a href=#12 id=12 data-nosnippet>12</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>default_entities;
13+
<a href=#13 id=13 data-nosnippet>13</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>default_entities_limits;
14+
<a href=#14 id=14 data-nosnippet>14</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>json_rules;
15+
<a href=#15 id=15 data-nosnippet>15</a>
16+
<a href=#16 id=16 data-nosnippet>16</a><span class="kw">pub mod </span>issuer_utils;
17+
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">pub mod </span>policy_store;
18+
<a href=#18 id=18 data-nosnippet>18</a>
19+
<a href=#19 id=19 data-nosnippet>19</a><span class="doccomment">/// Used for decoding the policy and schema metadata
20+
<a href=#20 id=20 data-nosnippet>20</a></span><span class="attr">#[derive(Debug, Copy, Clone, PartialEq, serde::Deserialize)]
21+
<a href=#21 id=21 data-nosnippet>21</a></span><span class="kw">enum </span>Encoding {
22+
<a href=#22 id=22 data-nosnippet>22</a> <span class="doccomment">/// indicates that the related value is base64 encoded
23+
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="attr">#[serde(rename = <span class="string">"base64"</span>)]
24+
<a href=#24 id=24 data-nosnippet>24</a> </span>Base64,
25+
<a href=#25 id=25 data-nosnippet>25</a>
26+
<a href=#26 id=26 data-nosnippet>26</a> <span class="doccomment">/// indicates that the related value is not encoded, ie it's just a plain string
27+
<a href=#27 id=27 data-nosnippet>27</a> </span><span class="attr">#[serde(rename = <span class="string">"none"</span>)]
28+
<a href=#28 id=28 data-nosnippet>28</a> </span><span class="prelude-val">None</span>,
29+
<a href=#29 id=29 data-nosnippet>29</a>}
30+
<a href=#30 id=30 data-nosnippet>30</a>
31+
<a href=#31 id=31 data-nosnippet>31</a><span class="doccomment">/// Used for decoding the policy and schema metadata
32+
<a href=#32 id=32 data-nosnippet>32</a></span><span class="attr">#[derive(Debug, Clone, serde::Deserialize)]
33+
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">enum </span>ContentType {
34+
<a href=#34 id=34 data-nosnippet>34</a> <span class="doccomment">/// indicates that the related value is in the cedar policy / schema language
35+
<a href=#35 id=35 data-nosnippet>35</a> </span><span class="attr">#[serde(rename = <span class="string">"cedar"</span>)]
36+
<a href=#36 id=36 data-nosnippet>36</a> </span>Cedar,
37+
<a href=#37 id=37 data-nosnippet>37</a>
38+
<a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// indicates that the related value is in the json representation of the cedar policy / schema language
39+
<a href=#39 id=39 data-nosnippet>39</a> </span><span class="attr">#[serde(rename = <span class="string">"cedar-json"</span>)]
40+
<a href=#40 id=40 data-nosnippet>40</a> </span>CedarJson,
41+
<a href=#41 id=41 data-nosnippet>41</a>}
42+
<a href=#42 id=42 data-nosnippet>42</a>
43+
<a href=#43 id=43 data-nosnippet>43</a><span class="comment">// Implement the trait for all iterators over Result&lt;T, E&gt;
44+
<a href=#44 id=44 data-nosnippet>44</a></span><span class="kw">impl</span>&lt;T, E, I&gt; PartitionResult&lt;T, E&gt; <span class="kw">for </span>I <span class="kw">where </span>I: Iterator&lt;Item = <span class="prelude-ty">Result</span>&lt;T, E&gt;&gt; {}
45+
<a href=#45 id=45 data-nosnippet>45</a>
46+
<a href=#46 id=46 data-nosnippet>46</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>PartitionResult&lt;T, E&gt;: Iterator&lt;Item = <span class="prelude-ty">Result</span>&lt;T, E&gt;&gt; + Sized {
47+
<a href=#47 id=47 data-nosnippet>47</a> <span class="doccomment">/// Splits an iterator of `Result&lt;T, E&gt;` into two separate `Vec`s:
48+
<a href=#48 id=48 data-nosnippet>48</a> /// one containing all `Ok(T)` values and the other containing all `Err(E)` values.
49+
<a href=#49 id=49 data-nosnippet>49</a> </span><span class="kw">fn </span>partition_result(<span class="self">self</span>) -&gt; (Vec&lt;T&gt;, Vec&lt;E&gt;) {
50+
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span><span class="kw-2">mut </span>ok = Vec::new();
51+
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span><span class="kw-2">mut </span>errs = Vec::new();
52+
<a href=#52 id=52 data-nosnippet>52</a>
53+
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">for </span>r <span class="kw">in </span><span class="self">self </span>{
54+
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">match </span>r {
55+
<a href=#55 id=55 data-nosnippet>55</a> <span class="prelude-val">Ok</span>(v) =&gt; ok.push(v),
56+
<a href=#56 id=56 data-nosnippet>56</a> <span class="prelude-val">Err</span>(e) =&gt; errs.push(e),
57+
<a href=#57 id=57 data-nosnippet>57</a> }
58+
<a href=#58 id=58 data-nosnippet>58</a> }
59+
<a href=#59 id=59 data-nosnippet>59</a> (ok, errs)
60+
<a href=#60 id=60 data-nosnippet>60</a> }
61+
<a href=#61 id=61 data-nosnippet>61</a>}</code></pre></div></section></main></body></html>

0 commit comments

Comments
 (0)