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 `Authorization` struct in crate `iron`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, Authorization" >
< title > iron::headers::Authorization - 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' > headers< / a > < / p > < script > window . sidebarCurrent = { name : 'Authorization' , 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' > headers< / a > ::< wbr > < a class = 'struct' href = '' > Authorization< / 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-1883' class = 'srclink' href = '../../hyper/header/common/authorization/struct.Authorization.html?gotosrc=1883' title = 'goto source code' > [src]< / a > < / span > < / h1 >
2016-10-09 07:40:00 -05:00
< pre class = 'rust struct' > pub struct Authorization< S> (pub S) < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > < / span > ;< / pre > < div class = 'docblock' > < p > < code > Authorization< / code > header, defined in < a href = "https://tools.ietf.org/html/rfc7235#section-4.2" > RFC7235< / a > < / p >
2016-09-11 13:41:24 -05:00
< p > The < code > Authorization< / code > header field allows a user agent to authenticate
itself with an origin server -- usually, but not necessarily, after
receiving a 401 (Unauthorized) response. Its value consists of
credentials containing the authentication information of the user
agent for the realm of the resource being requested.< / p >
< h1 id = 'abnf' class = 'section-header' > < a href = '#abnf' > ABNF< / a > < / h1 >
< pre > < code class = "language-plain" > Authorization = credentials
< / code > < / pre >
< h1 id = 'example-values' class = 'section-header' > < a href = '#example-values' > Example values< / a > < / h1 >
< ul >
< li > < code > Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==< / code > < / li >
< li > < code > Bearer fpKL54jvWmEGVoRdCNjG< / code > < / li >
< / ul >
< h1 id = 'examples' class = 'section-header' > < a href = '#examples' > Examples< / a > < / h1 >
< pre class = 'rust rust-example-rendered' >
< span class = 'kw' > use< / span > < span class = 'ident' > hyper< / span > ::< span class = 'ident' > header< / span > ::{< span class = 'ident' > Headers< / span > , < span class = 'ident' > Authorization< / span > };
< span class = 'kw' > let< / span > < span class = 'kw-2' > mut< / span > < span class = 'ident' > headers< / span > < span class = 'op' > =< / span > < span class = 'ident' > Headers< / span > ::< span class = 'ident' > new< / span > ();
< span class = 'ident' > headers< / span > .< span class = 'ident' > set< / span > (< span class = 'ident' > Authorization< / span > (< span class = 'string' > " let me in" < / span > .< span class = 'ident' > to_owned< / span > ()));< / pre >
< pre class = 'rust rust-example-rendered' >
< span class = 'kw' > use< / span > < span class = 'ident' > hyper< / span > ::< span class = 'ident' > header< / span > ::{< span class = 'ident' > Headers< / span > , < span class = 'ident' > Authorization< / span > , < span class = 'ident' > Basic< / span > };
< span class = 'kw' > let< / span > < span class = 'kw-2' > mut< / span > < span class = 'ident' > headers< / span > < span class = 'op' > =< / span > < span class = 'ident' > Headers< / span > ::< span class = 'ident' > new< / span > ();
< span class = 'ident' > headers< / span > .< span class = 'ident' > set< / span > (
< span class = 'ident' > Authorization< / span > (
< span class = 'ident' > Basic< / span > {
< span class = 'ident' > username< / span > : < span class = 'string' > " Aladdin" < / span > .< span class = 'ident' > to_owned< / span > (),
< span class = 'ident' > password< / span > : < span class = 'prelude-val' > Some< / span > (< span class = 'string' > " open sesame" < / span > .< span class = 'ident' > to_owned< / span > ())
}
)
);< / pre >
< pre class = 'rust rust-example-rendered' >
< span class = 'kw' > use< / span > < span class = 'ident' > hyper< / span > ::< span class = 'ident' > header< / span > ::{< span class = 'ident' > Headers< / span > , < span class = 'ident' > Authorization< / span > , < span class = 'ident' > Bearer< / span > };
< span class = 'kw' > let< / span > < span class = 'kw-2' > mut< / span > < span class = 'ident' > headers< / span > < span class = 'op' > =< / span > < span class = 'ident' > Headers< / span > ::< span class = 'ident' > new< / span > ();
< span class = 'ident' > headers< / span > .< span class = 'ident' > set< / span > (
< span class = 'ident' > Authorization< / span > (
< span class = 'ident' > Bearer< / span > {
< span class = 'ident' > token< / span > : < span class = 'string' > " QWxhZGRpbjpvcGVuIHNlc2FtZQ" < / span > .< span class = 'ident' > to_owned< / span > ()
}
)
);< / pre >
< / div > < h2 id = 'implementations' > Trait Implementations< / h2 > < h3 class = 'impl' > < span class = 'in-band' > < code > impl< S> < 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/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title = 'core::fmt::Debug' > Debug< / a > < / span > < / code > < / span > < span class = 'out-of-band' > < / 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 = '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< S> < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title = 'core::cmp::PartialEq' > PartialEq< / a > < < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> > for < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title = 'core::cmp::PartialEq' > PartialEq< / a > < S> < / span > < / code > < / span > < span class = 'out-of-band' > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.eq' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class = 'fnname' > eq< / a > (& self, __arg_0: & < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> ) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > < / code > < / h4 >
< 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 >
< / div > < h4 id = 'method.ne' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class = 'fnname' > ne< / a > (& self, __arg_0: & < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> ) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > < / code > < / h4 >
< div class = 'docblock' > < p > This method tests for < code > !=< / code > .< / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl< S> < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title = 'core::clone::Clone' > Clone< / a > for < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title = 'core::clone::Clone' > Clone< / a > < / span > < / code > < / span > < span class = 'out-of-band' > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.clone' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class = 'fnname' > clone< / a > (& self) -> < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < / code > < / h4 >
< div class = 'docblock' > < p > Returns a copy of the value. < a href = "https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" > Read more< / a > < / p >
< / div > < h4 id = 'method.clone_from' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class = 'fnname' > clone_from< / a > (& mut self, source: & Self)< / code > < div class = 'since' title = 'Stable since Rust version 1.0.0' > 1.0.0< / div > < / h4 >
< div class = 'docblock' > < p > Performs copy-assignment from < code > source< / code > . < a href = "https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" > Read more< / a > < / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl< S> < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html' title = 'core::ops::Deref' > Deref< / a > for < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > < / span > < / code > < / span > < span class = 'out-of-band' > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'associatedtype.Target' class = 'type' > < code > type < a href = 'https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#associatedtype.Target' class = 'type' > Target< / a > = S< / code > < / h4 >
< div class = 'docblock' > < p > The resulting type after dereferencing< / p >
< / div > < h4 id = 'method.deref' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/ops/trait.Deref.html#tymethod.deref' class = 'fnname' > deref< / a > (& self) -> & S< / code > < / h4 >
< div class = 'docblock' > < p > The method called to dereference a value< / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl< S> < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html' title = 'core::ops::DerefMut' > DerefMut< / a > for < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > < / span > < / code > < / span > < span class = 'out-of-band' > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.deref_mut' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/ops/trait.DerefMut.html#tymethod.deref_mut' class = 'fnname' > deref_mut< / a > (& mut self) -> & mut S< / code > < / h4 >
< / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl< S> < a class = 'trait' href = '../../iron/headers/trait.Header.html' title = 'iron::headers::Header' > Header< / a > for < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title = 'core::any::Any' > Any< / a > , S::< a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html' title = 'core::str::FromStr' > Err< / a > : 'static< / span > < / code > < / span > < span class = 'out-of-band' > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.header_name' class = 'method' > < code > fn < a href = '../../iron/headers/trait.Header.html#tymethod.header_name' class = 'fnname' > header_name< / a > () -> & 'static < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.str.html' > str< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Returns the name of the header field this belongs to. < a href = "../../iron/headers/trait.Header.html#tymethod.header_name" > Read more< / a > < / p >
< / div > < h4 id = 'method.parse_header' class = 'method' > < code > fn < a href = '../../iron/headers/trait.Header.html#tymethod.parse_header' class = 'fnname' > parse_header< / a > (raw: < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.slice.html' > & [< / a > < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title = 'collections::vec::Vec' > Vec< / a > < < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.u8.html' > u8< / a > > < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.slice.html' > ]< / a > ) -> < a class = 'enum' href = 'https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title = 'core::result::Result' > Result< / a > < < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> , < a class = 'enum' href = '../../iron/error/enum.HttpError.html' title = 'iron::error::HttpError' > Error< / a > > < / code > < / h4 >
< div class = 'docblock' > < p > Parse a header from a raw stream of bytes. < a href = "../../iron/headers/trait.Header.html#tymethod.parse_header" > Read more< / a > < / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl< S> < a class = 'trait' href = '../../iron/headers/trait.HeaderFormat.html' title = 'iron::headers::HeaderFormat' > HeaderFormat< / a > for < a class = 'struct' href = '../../iron/headers/struct.Authorization.html' title = 'iron::headers::Authorization' > Authorization< / a > < S> < span class = 'where' > where S: < a class = 'trait' href = '../../iron/headers/trait.Scheme.html' title = 'iron::headers::Scheme' > Scheme< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/any/trait.Any.html' title = 'core::any::Any' > Any< / a > , S::< a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html' title = 'core::str::FromStr' > Err< / a > : 'static< / span > < / code > < / span > < span class = 'out-of-band' > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.fmt_header' class = 'method' > < code > fn < a href = '../../iron/headers/trait.HeaderFormat.html#tymethod.fmt_header' class = 'fnname' > fmt_header< / 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 > Format a header to be output into a TcpStream. < a href = "../../iron/headers/trait.HeaderFormat.html#tymethod.fmt_header" > Read more< / a > < / p >
< / 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 >
