2016-09-11 13:41:24 -05:00
<!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 `IronError` struct in crate `iron`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, IronError" >
< title > iron::error::IronError - Rust< / title >
< link rel = "stylesheet" type = "text/css" href = "../../rustdoc.css" >
< link rel = "stylesheet" type = "text/css" href = "../../main.css" >
< link rel = "shortcut icon" href = "https://avatars0.githubusercontent.com/u/7853871?s=256" >
< / head >
< body class = "rustdoc" >
<!-- [if lte IE 8]>
< div class = "warning" >
This old browser is unsupported and will most likely display funky
things.
< / div >
<![endif]-->
< nav class = "sidebar" >
< a href = '../../iron/index.html' > < img src = 'https://avatars0.githubusercontent.com/u/7853871?s=128' alt = 'logo' width = '100' > < / a >
< p class = 'location' > < a href = '../index.html' > iron< / a > ::< wbr > < a href = 'index.html' > error< / a > < / p > < script > window . sidebarCurrent = { name : 'IronError' , ty : 'struct' , relpath : '' } ; < / script > < script defer src = "sidebar-items.js" > < / script >
< / nav >
< 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 ‘ ’ ‘ ’
type="search">
< / div >
< / form >
< / nav >
< section id = 'main' class = "content struct" >
< h1 class = 'fqn' > < span class = 'in-band' > Struct < a href = '../index.html' > iron< / a > ::< wbr > < a href = 'index.html' > error< / a > ::< wbr > < a class = 'struct' href = '' > IronError< / 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 id = 'src-40' class = 'srclink' href = '../../src/iron/error.rs.html#25-36' title = 'goto source code' > [src]< / a > < / span > < / h1 >
< pre class = 'rust struct' > pub struct IronError {
pub error: < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title = 'alloc::boxed::Box' > Box< / a > < < a class = 'trait' href = '../../iron/error/trait.Error.html' title = 'iron::error::Error' > Error< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/marker/trait.Send.html' title = 'core::marker::Send' > Send< / a > > ,
pub response: < a class = 'struct' href = '../../iron/response/struct.Response.html' title = 'iron::response::Response' > Response< / a > ,
}< / pre > < div class = 'docblock' > < p > The type of Errors inside and when using Iron.< / p >
< p > IronError informs its receivers of two things:< / p >
< ul >
< li > What went wrong< / li >
< li > What to do about it< / li >
< / ul >
< p > The < code > error< / code > field is responsible for informing receivers of which
error occured, and receivers may also modify the error field by layering
it (building up a cause chain).< / p >
< p > The < code > response< / code > field provides a tangible action to be taken if this error
is not otherwise handled.< / p >
< / div > < h2 class = 'fields' > Fields< / h2 > < span id = 'structfield.error' class = 'structfield' > < code > error: < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title = 'alloc::boxed::Box' > Box< / a > < < a class = 'trait' href = '../../iron/error/trait.Error.html' title = 'iron::error::Error' > Error< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/marker/trait.Send.html' title = 'core::marker::Send' > Send< / a > > < / code >
< / span > < span class = 'stab ' > < / span > < div class = 'docblock' > < p > The underlying error< / p >
< p > This can be layered and will be logged at the end of an errored
request.< / p >
< / div > < span id = 'structfield.response' class = 'structfield' > < code > response: < a class = 'struct' href = '../../iron/response/struct.Response.html' title = 'iron::response::Response' > Response< / a > < / code >
< / span > < span class = 'stab ' > < / span > < div class = 'docblock' > < p > What to do about this error.< / p >
< p > This Response will be used when the error-handling flow finishes.< / p >
< / div > < h2 id = 'methods' > Methods< / h2 > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'struct' href = '../../iron/error/struct.IronError.html' title = 'iron::error::IronError' > IronError< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-43' class = 'srclink' href = '../../src/iron/error.rs.html#38-46' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.new' class = 'method' > < code > fn < a href = '#method.new' class = 'fnname' > new< / a > < E: < a class = 'trait' href = '../../iron/error/trait.Error.html' title = 'iron::error::Error' > Error< / a > , M: < a class = 'trait' href = '../../modifier/trait.Modifier.html' title = 'modifier::Modifier' > Modifier< / a > < < a class = 'struct' href = '../../iron/response/struct.Response.html' title = 'iron::response::Response' > Response< / a > > > (e: E, m: M) -> < a class = 'struct' href = '../../iron/error/struct.IronError.html' title = 'iron::error::IronError' > IronError< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Create a new IronError from an error and a modifier.< / p >
< / div > < / 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/fmt/trait.Debug.html' title = 'core::fmt::Debug' > Debug< / a > for < a class = 'struct' href = '../../iron/error/struct.IronError.html' title = 'iron::error::IronError' > IronError< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-33' class = 'srclink' href = '../../src/iron/error.rs.html#24' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.fmt' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class = 'fnname' > fmt< / a > (& self, __arg_0: & mut < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title = 'core::fmt::Formatter' > Formatter< / a > ) -> < a class = 'type' href = 'https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title = 'core::fmt::Result' > Result< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Formats the value using the given formatter.< / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html' title = 'core::fmt::Display' > Display< / a > for < a class = 'struct' href = '../../iron/error/struct.IronError.html' title = 'iron::error::IronError' > IronError< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-49' class = 'srclink' href = '../../src/iron/error.rs.html#48-52' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.fmt-1' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class = 'fnname' > fmt< / a > (& self, f: & mut < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title = 'core::fmt::Formatter' > Formatter< / a > ) -> < a class = 'enum' href = 'https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title = 'core::result::Result' > Result< / a > < < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.tuple.html' > ()< / a > , < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html' title = 'core::fmt::Error' > Error< / a > > < / code > < / h4 >
< div class = 'docblock' > < p > Formats the value using the given formatter.< / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/std/error/trait.Error.html' title = 'std::error::Error' > StdError< / a > for < a class = 'struct' href = '../../iron/error/struct.IronError.html' title = 'iron::error::IronError' > IronError< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-53' class = 'srclink' href = '../../src/iron/error.rs.html#54-62' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.description' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description' class = 'fnname' > description< / a > (& self) -> & < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.str.html' > str< / a > < / code > < / h4 >
< div class = 'docblock' > < p > A short description of the error. < a href = "https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description" > Read more< / a > < / p >
< / div > < h4 id = 'method.cause' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class = 'fnname' > cause< / a > (& self) -> < a class = 'enum' href = 'https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title = 'core::option::Option' > Option< / a > < & < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/std/error/trait.Error.html' title = 'std::error::Error' > StdError< / a > > < / code > < / h4 >
2016-10-09 07:40:00 -05:00
< div class = 'docblock' > < p > The lower-level cause of this error, if any. < a href = "https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause" > Read more< / a > < / p >
2016-09-11 13:41:24 -05:00
< / div > < / div > < / 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 > ?< / dt >
< dd > Show this help dialog< / dd >
< dt > S< / dt >
< dd > Focus the search field< / dd >
< dt > ⇤ < / dt >
< dd > Move up in search results< / dd >
< dt > ⇥ < / dt >
< dd > Move down in search results< / dd >
< dt > ⏎ < / dt >
< dd > Go to active search result< / dd >
< dt > +< / dt >
< dd > Collapse/expand 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 >
< / div >
< / div >
< / aside >
< script >
window.rootPath = "../../";
window.currentCrate = "iron";
window.playgroundUrl = "";
< / script >
< script src = "../../jquery.js" > < / script >
< script src = "../../main.js" > < / script >
< script defer src = "../../search-index.js" > < / script >
< / body >
< / html >
