| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/jsonwebtoken-7.2.0/src/errors.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>errors.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../jsonwebtoken/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../jsonwebtoken/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::error::Error <span class="kw">as </span>StdError; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::result; |
| |
| <span class="doccomment">/// A crate private constructor for `Error`. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new_error(kind: ErrorKind) -> Error { |
| Error(Box::new(kind)) |
| } |
| |
| <span class="doccomment">/// A type alias for `Result<T, jsonwebtoken::Error>`. |
| </span><span class="kw">pub type </span><span class="prelude-ty">Result</span><T> = result::Result<T, Error>; |
| |
| <span class="doccomment">/// An error that can occur when encoding/decoding JWTs |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Error(Box<ErrorKind>); |
| |
| <span class="kw">impl </span>Error { |
| <span class="doccomment">/// Return the specific type of this error. |
| </span><span class="kw">pub fn </span>kind(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>ErrorKind { |
| <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| |
| <span class="doccomment">/// Unwrap this error into its underlying type. |
| </span><span class="kw">pub fn </span>into_kind(<span class="self">self</span>) -> ErrorKind { |
| <span class="kw-2">*</span><span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="doccomment">/// The specific type of an error. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub enum </span>ErrorKind { |
| <span class="doccomment">/// When a token doesn't have a valid JWT shape |
| </span>InvalidToken, |
| <span class="doccomment">/// When the signature doesn't match |
| </span>InvalidSignature, |
| <span class="doccomment">/// When the secret given is not a valid ECDSA key |
| </span>InvalidEcdsaKey, |
| <span class="doccomment">/// When the secret given is not a valid RSA key |
| </span>InvalidRsaKey, |
| <span class="doccomment">/// When the algorithm from string doesn't match the one passed to `from_str` |
| </span>InvalidAlgorithmName, |
| <span class="doccomment">/// When a key is provided with an invalid format |
| </span>InvalidKeyFormat, |
| |
| <span class="comment">// Validation errors |
| </span><span class="doccomment">/// When a token’s `exp` claim indicates that it has expired |
| </span>ExpiredSignature, |
| <span class="doccomment">/// When a token’s `iss` claim does not match the expected issuer |
| </span>InvalidIssuer, |
| <span class="doccomment">/// When a token’s `aud` claim does not match one of the expected audience values |
| </span>InvalidAudience, |
| <span class="doccomment">/// When a token’s `aud` claim does not match one of the expected audience values |
| </span>InvalidSubject, |
| <span class="doccomment">/// When a token’s nbf claim represents a time in the future |
| </span>ImmatureSignature, |
| <span class="doccomment">/// When the algorithm in the header doesn't match the one passed to `decode` or the encoding/decoding key |
| /// used doesn't match the alg requested |
| </span>InvalidAlgorithm, |
| |
| <span class="comment">// 3rd party errors |
| </span><span class="doccomment">/// An error happened when decoding some base64 text |
| </span>Base64(base64::DecodeError), |
| <span class="doccomment">/// An error happened while serializing/deserializing JSON |
| </span>Json(serde_json::Error), |
| <span class="doccomment">/// Some of the text was invalid UTF-8 |
| </span>Utf8(::std::string::FromUtf8Error), |
| <span class="doccomment">/// Something unspecified went wrong with crypto |
| </span>Crypto(::ring::error::Unspecified), |
| |
| <span class="doccomment">/// Hints that destructuring should not be exhaustive. |
| /// |
| /// This enum may grow additional variants, so this makes sure clients |
| /// don't count on exhaustive matching. (Otherwise, adding a new variant |
| /// could break existing code.) |
| </span><span class="attribute">#[doc(hidden)] |
| </span>__Nonexhaustive, |
| } |
| |
| <span class="kw">impl </span>StdError <span class="kw">for </span>Error { |
| <span class="kw">fn </span>cause(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="kw">dyn </span>StdError> { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self</span>.<span class="number">0 </span>{ |
| ErrorKind::InvalidToken => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidSignature => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidEcdsaKey => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidRsaKey => <span class="prelude-val">None</span>, |
| ErrorKind::ExpiredSignature => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidIssuer => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidAudience => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidSubject => <span class="prelude-val">None</span>, |
| ErrorKind::ImmatureSignature => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidAlgorithm => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidAlgorithmName => <span class="prelude-val">None</span>, |
| ErrorKind::InvalidKeyFormat => <span class="prelude-val">None</span>, |
| ErrorKind::Base64(<span class="kw-2">ref </span>err) => <span class="prelude-val">Some</span>(err), |
| ErrorKind::Json(<span class="kw-2">ref </span>err) => <span class="prelude-val">Some</span>(err), |
| ErrorKind::Utf8(<span class="kw-2">ref </span>err) => <span class="prelude-val">Some</span>(err), |
| ErrorKind::Crypto(<span class="kw-2">ref </span>err) => <span class="prelude-val">Some</span>(err), |
| ErrorKind::__Nonexhaustive => <span class="prelude-val">None</span>, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Display <span class="kw">for </span>Error { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self</span>.<span class="number">0 </span>{ |
| ErrorKind::InvalidToken |
| | ErrorKind::InvalidSignature |
| | ErrorKind::InvalidEcdsaKey |
| | ErrorKind::InvalidRsaKey |
| | ErrorKind::ExpiredSignature |
| | ErrorKind::InvalidIssuer |
| | ErrorKind::InvalidAudience |
| | ErrorKind::InvalidSubject |
| | ErrorKind::ImmatureSignature |
| | ErrorKind::InvalidAlgorithm |
| | ErrorKind::InvalidKeyFormat |
| | ErrorKind::InvalidAlgorithmName => <span class="macro">write!</span>(f, <span class="string">"{:?}"</span>, <span class="self">self</span>.<span class="number">0</span>), |
| ErrorKind::Json(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"JSON error: {}"</span>, err), |
| ErrorKind::Utf8(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"UTF-8 error: {}"</span>, err), |
| ErrorKind::Crypto(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"Crypto error: {}"</span>, err), |
| ErrorKind::Base64(<span class="kw-2">ref </span>err) => <span class="macro">write!</span>(f, <span class="string">"Base64 error: {}"</span>, err), |
| ErrorKind::__Nonexhaustive => <span class="macro">write!</span>(f, <span class="string">"Unknown error"</span>), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<base64::DecodeError> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(err: base64::DecodeError) -> Error { |
| new_error(ErrorKind::Base64(err)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<serde_json::Error> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(err: serde_json::Error) -> Error { |
| new_error(ErrorKind::Json(err)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<::std::string::FromUtf8Error> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(err: ::std::string::FromUtf8Error) -> Error { |
| new_error(ErrorKind::Utf8(err)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<::ring::error::Unspecified> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(err: ::ring::error::Unspecified) -> Error { |
| new_error(ErrorKind::Crypto(err)) |
| } |
| } |
| |
| <span class="kw">impl </span>From<::ring::error::KeyRejected> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(_err: ::ring::error::KeyRejected) -> Error { |
| new_error(ErrorKind::InvalidEcdsaKey) |
| } |
| } |
| |
| <span class="kw">impl </span>From<ErrorKind> <span class="kw">for </span>Error { |
| <span class="kw">fn </span>from(kind: ErrorKind) -> Error { |
| new_error(kind) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_error_rendering() { |
| <span class="macro">assert_eq!</span>( |
| <span class="string">"InvalidAlgorithmName"</span>, |
| Error::from(ErrorKind::InvalidAlgorithmName).to_string() |
| ); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="jsonwebtoken" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
