| <!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="Contains detailed error representation."><meta name="keywords" content="rust, rustlang, rust-lang, error"><title>image::error - Rust</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="../../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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module error</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Module <a href="../index.html">image</a>::<wbr><a class="mod" href="#">error</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/image/error.rs.html#1-534">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Contains detailed error representation.</p> |
| <p>See the main <a href="enum.ImageError.html"><code>ImageError</code></a> which contains a variant for each specialized error type. The |
| subtypes used in each variant are opaque by design. They can be roughly inspected through their |
| respective <code>kind</code> methods which work similar to <code>std::io::Error::kind</code>.</p> |
| <p>The error interface makes it possible to inspect the error of an underlying decoder or encoder, |
| through the <code>Error::source</code> method. Note that this is not part of the stable interface and you |
| may not rely on a particular error value for a particular operation. This means mainly that |
| <code>image</code> does not promise to remain on a particular version of its underlying decoders but if |
| you ensure to use the same version of the dependency (or at least of the error type) through |
| external means then you could inspect the error type in slightly more detail.</p> |
| </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DecodingError.html" title="image::error::DecodingError struct">DecodingError</a></div><div class="item-right docblock-short">An error was encountered while decoding an image.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.EncodingError.html" title="image::error::EncodingError struct">EncodingError</a></div><div class="item-right docblock-short">An error was encountered while encoding an image.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.LimitError.html" title="image::error::LimitError struct">LimitError</a></div><div class="item-right docblock-short">Completing the operation would have required more resources than allowed.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParameterError.html" title="image::error::ParameterError struct">ParameterError</a></div><div class="item-right docblock-short">An error was encountered in inputs arguments.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UnsupportedError.html" title="image::error::UnsupportedError struct">UnsupportedError</a></div><div class="item-right docblock-short">The implementation for an operation was not provided.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ImageError.html" title="image::error::ImageError enum">ImageError</a></div><div class="item-right docblock-short">The generic error type for image operations.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ImageFormatHint.html" title="image::error::ImageFormatHint enum">ImageFormatHint</a></div><div class="item-right docblock-short">A best effort representation for image formats.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LimitErrorKind.html" title="image::error::LimitErrorKind enum">LimitErrorKind</a></div><div class="item-right docblock-short">Indicates the limit that prevented an operation from completing.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ParameterErrorKind.html" title="image::error::ParameterErrorKind enum">ParameterErrorKind</a></div><div class="item-right docblock-short">Details how a parameter is malformed.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.UnsupportedErrorKind.html" title="image::error::UnsupportedErrorKind enum">UnsupportedErrorKind</a></div><div class="item-right docblock-short">Details what feature is not supported.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.ImageResult.html" title="image::error::ImageResult type">ImageResult</a></div><div class="item-right docblock-short">Result of an image decoding/encoding process</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="image" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
