39 lines
7.3 KiB
HTML
39 lines
7.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>PathHandler.addMapping (handy_http_handlers.path_handler.PathHandler.addMapping)</title>
|
|
<meta charset="utf-8" />
|
|
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
<script src="script.js" type="text/javascript"></script>
|
|
|
|
|
|
<link href="search-results.html" rel="prefetch" />
|
|
</head>
|
|
<body>
|
|
<div id="page-header">
|
|
<div id="logotype">
|
|
<span>Documentation</span>
|
|
<nav>
|
|
<a href="http://dlang.org/">Dlang.org</a>
|
|
</nav>
|
|
</div>
|
|
|
|
<form action="search-docs.html" id="search">
|
|
<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
<div id="page-body">
|
|
<div id="page-content">
|
|
<h1>PathHandler.addMapping</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_handlers.html">handy_http_handlers</a> <a class="breadcrumb" href="handy_http_handlers.path_handler.html">path_handler</a> <a class="breadcrumb" href="handy_http_handlers.path_handler.PathHandler.html">PathHandler</a> </div><div><div class="documentation-comment synopsis"><div><p>Adds a mapping to this handler, such that requests which match the given
|
|
method and pattern will be handed off to the given handler.</p><p>Overloaded variations of this method are defined for your convenience,
|
|
which allow you to add a mapping for multiple HTTP methods and/or path
|
|
patterns.</p></div></div></div><div class="annotated-prototype"><ol class="overloads"><li class="active-overload-option"><span class="overload-signature"><tt class="highlighted"><span class="hid">PathHandler</span></tt> <span class="name">addMapping</span>(HttpMethod method, string pattern, HttpRequestHandler handler)</span><div class="function-prototype"><div class="parent-prototype"><span class="builtin-type">class</span> <span class="name">PathHandler</span></div><div><div class="attributes"></div><div class="return-type"><a class="name" data-ident="PathHandler" href="handy_http_handlers.path_handler.PathHandler.html" title="handy_http_handlers.path_handler.PathHandler">PathHandler</a></div><div class="function-name">addMapping</div><div class="template-parameters" data-count="0"></div><div class="runtime-parameters" data-count="3"><div class="parameters-list toplevel"><span class="paren">(</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="name" data-ident="HttpMethod">HttpMethod</span></span></span> <span class="parameter-name name" data-ident="method"><a href="#param-method">method</a></span></div><span class="comma">,</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="builtin-type">string</span></span></span> <span class="parameter-name name" data-ident="pattern"><a href="#param-pattern">pattern</a></span></div><span class="comma">,</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="name" data-ident="HttpRequestHandler">HttpRequestHandler</span></span></span> <span class="parameter-name name" data-ident="handler"><a href="#param-handler">handler</a></span></div><span class="paren">)</span></div></div><div class="function-contracts"></div></div></div></li><li class="overload-option"><a href="handy_http_handlers.path_handler.PathHandler.addMapping.2.html"><span class="overload-signature"><tt class="highlighted"><span class="hid">PathHandler</span></tt> <span class="name">addMapping</span>(HttpMethod[] methods, string pattern, HttpRequestHandler handler)</span></a></li><li class="overload-option"><a href="handy_http_handlers.path_handler.PathHandler.addMapping.3.html"><span class="overload-signature"><tt class="highlighted"><span class="hid">PathHandler</span></tt> <span class="name">addMapping</span>(HttpMethod method, string[] patterns, HttpRequestHandler handler)</span></a></li><li class="overload-option"><a href="handy_http_handlers.path_handler.PathHandler.addMapping.4.html"><span class="overload-signature"><tt class="highlighted"><span class="hid">PathHandler</span></tt> <span class="name">addMapping</span>(HttpMethod[] methods, string[] patterns, HttpRequestHandler handler)</span></a></li><li class="overload-option"><a href="handy_http_handlers.path_handler.PathHandler.addMapping.5.html"><span class="overload-signature"><tt class="highlighted"><span class="hid">PathHandler</span></tt> <span class="name">addMapping</span>(string pattern, HttpRequestHandler handler)</span></a></li></ol></div><div><h2 id="parameters"><a class="header-anchor" href="#parameters">Parameters</a></h2><dl class="parameter-descriptions"><dt id="param-method"><a class="parameter-name" data-ident="method" href="#param-method">method</a> <span class="parameter-type"><span class="name" data-ident="HttpMethod">HttpMethod</span></span></dt><dd><div class="documentation-comment"><div><p>The HTTP method to match against.</p></div></div></dd><dt id="param-pattern"><a class="parameter-name" data-ident="pattern" href="#param-pattern">pattern</a> <span class="parameter-type"><span class="builtin-type">string</span></span></dt><dd><div class="documentation-comment"><div><p>The path pattern to match against. See <a href="https://github.com/andrewlalis/path-matcher">https://github.com/andrewlalis/path-matcher</a>
|
|
for more details on the pattern's format.</p></div></div></dd><dt id="param-handler"><a class="parameter-name" data-ident="handler" href="#param-handler">handler</a> <span class="parameter-type"><span class="name" data-ident="HttpRequestHandler">HttpRequestHandler</span></span></dt><dd><div class="documentation-comment"><div><p>The handler that will handle matching requests.</p></div></div></dd></dl><h2 id="returns"><a class="header-anchor" href="#returns">Return Value</a></h2><div><div class="return-type-holder">Type: <span class="return-type"><a class="xref" href="handy_http_handlers.path_handler.PathHandler.html" title="handy_http_handlers.path_handler.PathHandler"><span class="name" data-ident="PathHandler">PathHandler</span></a></span></div><div class="documentation-comment returns-description"><div><p>This path handler, for method chaining.</p></div></div></div></div></div>
|
|
<div id="page-nav"><a class="parent" href="handy_http_handlers.html">handy_http_handlers</a> <a class="parent" href="handy_http_handlers.path_handler.html">path_handler</a> <a class="parent" href="handy_http_handlers.path_handler.PathHandler.html">PathHandler</a>
|
|
<span class="type-separator">constructors</span><ul><li><a class="constructor" href="handy_http_handlers.path_handler.PathHandler.this.html">this</a></li></ul><span class="type-separator">functions</span><ul><li><a class="function current" href="handy_http_handlers.path_handler.PathHandler.addMapping.1.html">addMapping</a></li><li><a class="function" href="handy_http_handlers.path_handler.PathHandler.handle.html">handle</a></li><li><a class="function" href="handy_http_handlers.path_handler.PathHandler.registerHandlers.html">registerHandlers</a></li><li><a class="function" href="handy_http_handlers.path_handler.PathHandler.setNotFoundHandler.html">setNotFoundHandler</a></li></ul></div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
</body>
|
|
</html> |