HeadersPattern

internal

Stubbing and setting expectations on 'HTTP' requests.
Includes tools for stubbing 'HTTP' requests, including expected
request conditions and response conditions. Match on
'HTTP' method, query parameters, request body, headers and
more. Can be used for unit tests or outside of a testing
context.

Scott Chamberlain

webmockr

Stubbing and Setting Expectations on 'HTTP' Requests

Aaron Wolen

rOpenSci 

HeadersPattern function

<p><div class="r6-fields"></div></p><dl>
<dt><code>pattern</code></dt>
<dd><p>a list</p></dd><p></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/HeadersPattern%24new()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::HeadersPattern$new()"><code>HeadersPattern$new()</code></a></p></li>
<li><p><a href="/link/HeadersPattern%24matches()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::HeadersPattern$matches()"><code>HeadersPattern$matches()</code></a></p></li>
<li><p><a href="/link/HeadersPattern%24empty_headers()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::HeadersPattern$empty_headers()"><code>HeadersPattern$empty_headers()</code></a></p></li>
<li><p><a href="/link/HeadersPattern%24to_s()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::HeadersPattern$to_s()"><code>HeadersPattern$to_s()</code></a></p></li>
<li><p><a href="/link/HeadersPattern%24clone()?package=webmockr&version=2.2.0" data-mini-rdoc="webmockr::HeadersPattern$clone()"><code>HeadersPattern$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-HeadersPattern-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new <code>HeadersPattern</code> object</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>HeadersPattern$new(pattern)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>pattern</code></dt>
<dd><p>(list) a pattern, as a named list, must be named,
e.g,. <code>list(a = 5, b = 6)</code></p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A new <code>HeadersPattern</code> object</p>
</div><p></p><p></p><p><hr>
<a id="method-HeadersPattern-matches"></a></p><div class="section" id="method-matches-">
<h3>Method <code>matches()</code></h3>
<p>Match a list of headers against that stored</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>HeadersPattern$matches(headers)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>headers</code></dt>
<dd><p>(list) named list of headers, e.g,. <code>list(a = 5, b = 6)</code></p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>a boolean</p>
</div><p></p><p></p><p><hr>
<a id="method-HeadersPattern-empty_headers"></a></p><div class="section" id="method-empty-headers-">
<h3>Method <code>empty_headers()</code></h3>
<p>Are headers empty? tests if null or length==0</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>HeadersPattern$empty_headers(headers)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>headers</code></dt>
<dd><p>named list of headers</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>a boolean</p>
</div><p></p><p></p><p><hr>
<a id="method-HeadersPattern-to_s"></a></p><div class="section" id="method-to-s-">
<h3>Method <code>to_s()</code></h3>
<p>Print pattern for easy human consumption</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>HeadersPattern$to_s()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>a string</p>
</div></p><p></p><p><hr>
<a id="method-HeadersPattern-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>HeadersPattern$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

HeadersPattern — HeadersPattern

<p><div class="r6-fields"></p><dl>
<dt><code>pattern</code></dt>
<dd><p>a list</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-HeadersPattern-new'><code>HeadersPattern$new()</code></a></p></li>
<li><p><a href='#method-HeadersPattern-matches'><code>HeadersPattern$matches()</code></a></p></li>
<li><p><a href='#method-HeadersPattern-empty_headers'><code>HeadersPattern$empty_headers()</code></a></p></li>
<li><p><a href='#method-HeadersPattern-to_s'><code>HeadersPattern$to_s()</code></a></p></li>
<li><p><a href='#method-HeadersPattern-clone'><code>HeadersPattern$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-HeadersPattern-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new <code>HeadersPattern</code> object</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>HeadersPattern$new(pattern)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>pattern</code></dt>
<dd><p>(list) a pattern, as a named list, must be named,
e.g,. <code>list(a = 5, b = 6)</code></p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A new <code>HeadersPattern</code> object</p>
</div>

</div><p><hr>
<a id="method-HeadersPattern-matches"></a></p><div class='section' id='method-matches-'>
<h3>Method <code>matches()</code></h3>
<p>Match a list of headers against that stored</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>HeadersPattern$matches(headers)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>headers</code></dt>
<dd><p>(list) named list of headers, e.g,. <code>list(a = 5, b = 6)</code></p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>a boolean</p>
</div>

</div><p><hr>
<a id="method-HeadersPattern-empty_headers"></a></p><div class='section' id='method-empty-headers-'>
<h3>Method <code>empty_headers()</code></h3>
<p>Are headers empty? tests if null or length==0</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>HeadersPattern$empty_headers(headers)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>headers</code></dt>
<dd><p>named list of headers</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>a boolean</p>
</div>

</div><p><hr>
<a id="method-HeadersPattern-to_s"></a></p><div class='section' id='method-to-s-'>
<h3>Method <code>to_s()</code></h3>
<p>Print pattern for easy human consumption</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>HeadersPattern$to_s()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>a string</p>
</div>

</div><p><hr>
<a id="method-HeadersPattern-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>HeadersPattern$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


HeadersPattern: HeadersPattern

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `matches()`

Usage

Arguments

Returns

Method `empty_headers()`

Usage

Arguments

Returns

Method `to_s()`

Usage

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method matches()

Usage

Arguments

Returns

Method empty_headers()

Usage

Arguments

Returns

Method to_s()

Usage

Returns

Method clone()

Usage

Arguments

Details

Method `new()`

Method `matches()`

Method `empty_headers()`

Method `to_s()`

Method `clone()`