mirror of
https://github.com/actix/actix-website
synced 2024-12-18 18:03:12 +01:00
280 lines
19 KiB
HTML
280 lines
19 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `error` mod in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, error"><title>actix_web::error - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Module error</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>actix_web</a></p><script>window.sidebarCurrent = {name: 'error', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>actix_web</a>::<wbr><a class="mod" href=''>error</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/actix_web/error.rs.html#1-1121' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>Error and Result module</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Error.html"
|
||
title='struct actix_web::error::Error'>Error</a></td>
|
||
<td class='docblock-short'>
|
||
<p>General purpose actix web error.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.InternalError.html"
|
||
title='struct actix_web::error::InternalError'>InternalError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper type that can wrap any error and generate custom response.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.ContentTypeError.html"
|
||
title='enum actix_web::error::ContentTypeError'>ContentTypeError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of error that can occure during parsing content type</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.CookieParseError.html"
|
||
title='enum actix_web::error::CookieParseError'>CookieParseError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Enum corresponding to a parsing error.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.ExpectError.html"
|
||
title='enum actix_web::error::ExpectError'>ExpectError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error during handling <code>Expect</code> header</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.JsonPayloadError.html"
|
||
title='enum actix_web::error::JsonPayloadError'>JsonPayloadError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur during parsing json payloads</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.MultipartError.html"
|
||
title='enum actix_web::error::MultipartError'>MultipartError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur during parsing multipart streams</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.ParseError.html"
|
||
title='enum actix_web::error::ParseError'>ParseError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur during parsing HTTP streams</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.PayloadError.html"
|
||
title='enum actix_web::error::PayloadError'>PayloadError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur during payload parsing</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.ReadlinesError.html"
|
||
title='enum actix_web::error::ReadlinesError'>ReadlinesError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error type returned when reading body as lines.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.StaticFileError.html"
|
||
title='enum actix_web::error::StaticFileError'>StaticFileError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Errors which can occur when serving static files.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.UriSegmentError.html"
|
||
title='enum actix_web::error::UriSegmentError'>UriSegmentError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Errors which can occur when attempting to interpret a segment string as a
|
||
valid path segment.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.UrlGenerationError.html"
|
||
title='enum actix_web::error::UrlGenerationError'>UrlGenerationError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Errors which can occur when attempting to generate resource uri.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.UrlParseError.html"
|
||
title='enum actix_web::error::UrlParseError'>UrlParseError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Errors that can occur during parsing.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.UrlencodedError.html"
|
||
title='enum actix_web::error::UrlencodedError'>UrlencodedError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A set of errors that can occur during parsing urlencoded payloads</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.ResponseError.html"
|
||
title='trait actix_web::error::ResponseError'>ResponseError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error that can be converted to <code>HttpResponse</code></p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorBadGateway.html"
|
||
title='fn actix_web::error::ErrorBadGateway'>ErrorBadGateway</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and
|
||
generate <em>BAD GATEWAY</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorBadRequest.html"
|
||
title='fn actix_web::error::ErrorBadRequest'>ErrorBadRequest</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>BAD
|
||
REQUEST</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorConflict.html"
|
||
title='fn actix_web::error::ErrorConflict'>ErrorConflict</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>CONFLICT</em>
|
||
response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorExpectationFailed.html"
|
||
title='fn actix_web::error::ErrorExpectationFailed'>ErrorExpectationFailed</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate
|
||
<em>EXPECTATION FAILED</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorForbidden.html"
|
||
title='fn actix_web::error::ErrorForbidden'>ErrorForbidden</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>FORBIDDEN</em>
|
||
response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorGatewayTimeout.html"
|
||
title='fn actix_web::error::ErrorGatewayTimeout'>ErrorGatewayTimeout</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and
|
||
generate <em>GATEWAY TIMEOUT</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorGone.html"
|
||
title='fn actix_web::error::ErrorGone'>ErrorGone</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>GONE</em>
|
||
response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorInternalServerError.html"
|
||
title='fn actix_web::error::ErrorInternalServerError'>ErrorInternalServerError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and
|
||
generate <em>INTERNAL SERVER ERROR</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorMethodNotAllowed.html"
|
||
title='fn actix_web::error::ErrorMethodNotAllowed'>ErrorMethodNotAllowed</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>METHOD NOT
|
||
ALLOWED</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorNotFound.html"
|
||
title='fn actix_web::error::ErrorNotFound'>ErrorNotFound</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>NOT FOUND</em>
|
||
response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorNotImplemented.html"
|
||
title='fn actix_web::error::ErrorNotImplemented'>ErrorNotImplemented</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and
|
||
generate <em>NOT IMPLEMENTED</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorPreconditionFailed.html"
|
||
title='fn actix_web::error::ErrorPreconditionFailed'>ErrorPreconditionFailed</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate
|
||
<em>PRECONDITION FAILED</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorRequestTimeout.html"
|
||
title='fn actix_web::error::ErrorRequestTimeout'>ErrorRequestTimeout</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate <em>REQUEST
|
||
TIMEOUT</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorServiceUnavailable.html"
|
||
title='fn actix_web::error::ErrorServiceUnavailable'>ErrorServiceUnavailable</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and
|
||
generate <em>SERVICE UNAVAILABLE</em> response.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.ErrorUnauthorized.html"
|
||
title='fn actix_web::error::ErrorUnauthorized'>ErrorUnauthorized</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Helper function that creates wrapper of any error and generate
|
||
<em>UNAUTHORIZED</em> response.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.Result.html"
|
||
title='type actix_web::error::Result'>Result</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A specialized <a href="https://doc.rust-lang.org/std/result/enum.Result.html"><code>Result</code></a>
|
||
for actix web operations</p>
|
||
|
||
</td>
|
||
</tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |