Skip to content

Commit 3eb7977

Browse files
lipanskilipanski
committed
Generate docs
1 parent cb8c5b4 commit 3eb7977

12 files changed

+800
-307
lines changed

‎docs/generated/mockito/constant.SERVER_ADDRESS.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h1 class='fqn'><span class='in-band'>Constant <a href='index.html'>mockito</a>:
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/mockito/lib.rs.html#195' title='goto source code'>[src]</a></span></h1>
51+
</span><a class='srclink' href='../src/mockito/lib.rs.html#253' title='goto source code'>[src]</a></span></h1>
5252
<pre class='rust const'>pub const SERVER_ADDRESS: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><code> = </code><code>&quot;127.0.0.1:1234&quot;</code></pre><div class='docblock'><p>Points to the address the mock server is running at.
5353
Can be used with <code>std::net::TcpStream</code>.</p>
5454
</div></section>

‎docs/generated/mockito/constant.SERVER_URL.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h1 class='fqn'><span class='in-band'>Constant <a href='index.html'>mockito</a>:
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/mockito/lib.rs.html#200' title='goto source code'>[src]</a></span></h1>
51+
</span><a class='srclink' href='../src/mockito/lib.rs.html#258' title='goto source code'>[src]</a></span></h1>
5252
<pre class='rust const'>pub const SERVER_URL: &amp;'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><code> = </code><code>&quot;http://127.0.0.1:1234&quot;</code></pre><div class='docblock'><p>Points to the URL the mock server is running at.</p>
5353
</div></section>
5454
<section id='search' class="content hidden"></section>

‎docs/generated/mockito/enum.Matcher.html

+13-11
Original file line numberDiff line numberDiff line change
@@ -48,32 +48,34 @@ <h1 class='fqn'><span class='in-band'>Enum <a href='index.html'>mockito</a>::<wb
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/mockito/lib.rs.html#245-253' title='goto source code'>[src]</a></span></h1>
51+
</span><a class='srclink' href='../src/mockito/lib.rs.html#303-313' title='goto source code'>[src]</a></span></h1>
5252
<pre class='rust enum'>pub enum Matcher {
5353
Exact(<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>),
54+
Regex(<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>),
5455
Any,
5556
Missing,
56-
}</pre><div class='docblock'><p>Allows matching headers in multiple ways: matching the exact field name and value, matching only by field name
57-
or matching that the field name is not present at all.</p>
57+
}</pre><div class='docblock'><p>Allows matching the request path or headers in multiple ways: matching the exact value, matching any value (as
58+
long as it is present), matching by regular expression or checking that a particular header is missing.</p>
5859

59-
<p>These matchers are used within the <code>Mock::match_header</code> call.</p>
60+
<p>These matchers are used within the <code>mock</code> and <code>Mock::match_header</code> calls.</p>
6061
</div><h2 class='variants'>Variants</h2>
61-
<span id='variant.Exact' class='variant'><span id='Exact.v' class='invisible'><code>Exact(<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>)</code></span></span><div class='docblock'><p>Given the header field, matches the exact header value. There&#39;s also an implementation of <code>From&lt;&amp;str&gt;</code>
62+
<span id='variant.Exact' class='variant'><span id='Exact.v' class='invisible'><code>Exact(<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>)</code></span></span><div class='docblock'><p>Matches the exact path or header value. There&#39;s also an implementation of <code>From&lt;&amp;str&gt;</code>
6263
to keep things simple and backwards compatible.</p>
63-
</div><span id='variant.Any' class='variant'><span id='Any.v' class='invisible'><code>Any</code></span></span><div class='docblock'><p>Given the header field, matches any header value.</p>
64-
</div><span id='variant.Missing' class='variant'><span id='Missing.v' class='invisible'><code>Missing</code></span></span><div class='docblock'><p>Matches when the header field is <em>not</em> be present in the request.</p>
65-
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#244' title='goto source code'>[src]</a></span></h3>
64+
</div><span id='variant.Regex' class='variant'><span id='Regex.v' class='invisible'><code>Regex(<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>)</code></span></span><div class='docblock'><p>Matches a path or header value by a regular expression.</p>
65+
</div><span id='variant.Any' class='variant'><span id='Any.v' class='invisible'><code>Any</code></span></span><div class='docblock'><p>Matches any path or any header value.</p>
66+
</div><span id='variant.Missing' class='variant'><span id='Missing.v' class='invisible'><code>Missing</code></span></span><div class='docblock'><p>Checks that a header is not present in the request.</p>
67+
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#302' title='goto source code'>[src]</a></span></h3>
6668
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
6769
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
6870
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
6971
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
70-
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#244' title='goto source code'>[src]</a></span></h3>
72+
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#302' title='goto source code'>[src]</a></span></h3>
7173
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
7274
<div class='docblock'><p>Formats the value using the given formatter.</p>
73-
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt; for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#255-259' title='goto source code'>[src]</a></span></h3>
75+
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&amp;'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt; for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#315-319' title='goto source code'>[src]</a></span></h3>
7476
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(value: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span></h4>
7577
<div class='docblock'><p>Performs the conversion.</p>
76-
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt; for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#261-269' title='goto source code'>[src]</a></span></h3>
78+
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>&gt; for <a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mockito/lib.rs.html#321-330' title='goto source code'>[src]</a></span></h3>
7779
<div class='impl-items'><h4 id='method.eq-1' class="method"><span id='eq.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/collections/string/struct.String.html" title="struct collections::string::String">String</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
7880
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
7981
</div><h4 id='method.ne-1' class="method"><span id='ne.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;Rhs) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>

‎docs/generated/mockito/fn.mock.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ <h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mockito</a>:
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/mockito/lib.rs.html#217-219' title='goto source code'>[src]</a></span></h1>
52-
<pre class='rust fn'>pub fn mock(method: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, path: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="../mockito/struct.Mock.html" title="struct mockito::Mock">Mock</a></pre><div class='docblock'><p>Initializes a mock for the provided <code>method</code> and <code>path</code>.</p>
51+
</span><a class='srclink' href='../src/mockito/lib.rs.html#275-277' title='goto source code'>[src]</a></span></h1>
52+
<pre class='rust fn'>pub fn mock&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="../mockito/enum.Matcher.html" title="enum mockito::Matcher">Matcher</a>&gt;&gt;(method: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, path: P) -&gt; <a class="struct" href="../mockito/struct.Mock.html" title="struct mockito::Mock">Mock</a></pre><div class='docblock'><p>Initializes a mock for the provided <code>method</code> and <code>path</code>.</p>
5353

5454
<p>The mock is registered to the server only after the <code>create()</code> method has been called.</p>
5555

‎docs/generated/mockito/fn.reset.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mockito</a>:
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/mockito/lib.rs.html#224-231' title='goto source code'>[src]</a></span></h1>
51+
</span><a class='srclink' href='../src/mockito/lib.rs.html#282-289' title='goto source code'>[src]</a></span></h1>
5252
<pre class='rust fn'>pub fn reset()</pre><div class='docblock'><p>Removes all the mocks stored on the server.</p>
5353
</div></section>
5454
<section id='search' class="content hidden"></section>

‎docs/generated/mockito/fn.start.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ <h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mockito</a>:
4848
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
4949
[<span class='inner'>&#x2212;</span>]
5050
</a>
51-
</span><a class='srclink' href='../src/mockito/lib.rs.html#234-236' title='goto source code'>[src]</a></span></h1>
51+
</span><a class='srclink' href='../src/mockito/lib.rs.html#292-294' title='goto source code'>[src]</a></span></h1>
5252
<pre class='rust fn'>pub fn start()</pre></section>
5353
<section id='search' class="content hidden"></section>
5454

0 commit comments

Comments
 (0)