11 lines
7.0 KiB
HTML
11 lines
7.0 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="Contains detailed error representation."><title>image::error - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="image" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../image/index.html">image</a><span class="version">0.25.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module error</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate image</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">image</a></span><h1>Module <span>error</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/image/error.rs.html#1-514">Source</a> </span></div><details class="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="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.DecodingError.html" title="struct image::error::DecodingError">Decoding<wbr>Error</a></div><div class="desc docblock-short">An error was encountered while decoding an image.</div></li><li><div class="item-name"><a class="struct" href="struct.EncodingError.html" title="struct image::error::EncodingError">Encoding<wbr>Error</a></div><div class="desc docblock-short">An error was encountered while encoding an image.</div></li><li><div class="item-name"><a class="struct" href="struct.LimitError.html" title="struct image::error::LimitError">Limit<wbr>Error</a></div><div class="desc docblock-short">Completing the operation would have required more resources than allowed.</div></li><li><div class="item-name"><a class="struct" href="struct.ParameterError.html" title="struct image::error::ParameterError">Parameter<wbr>Error</a></div><div class="desc docblock-short">An error was encountered in inputs arguments.</div></li><li><div class="item-name"><a class="struct" href="struct.UnsupportedError.html" title="struct image::error::UnsupportedError">Unsupported<wbr>Error</a></div><div class="desc docblock-short">The implementation for an operation was not provided.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ImageError.html" title="enum image::error::ImageError">Image<wbr>Error</a></div><div class="desc docblock-short">The generic error type for image operations.</div></li><li><div class="item-name"><a class="enum" href="enum.ImageFormatHint.html" title="enum image::error::ImageFormatHint">Image<wbr>Format<wbr>Hint</a></div><div class="desc docblock-short">A best effort representation for image formats.</div></li><li><div class="item-name"><a class="enum" href="enum.LimitErrorKind.html" title="enum image::error::LimitErrorKind">Limit<wbr>Error<wbr>Kind</a></div><div class="desc docblock-short">Indicates the limit that prevented an operation from completing.</div></li><li><div class="item-name"><a class="enum" href="enum.ParameterErrorKind.html" title="enum image::error::ParameterErrorKind">Parameter<wbr>Error<wbr>Kind</a></div><div class="desc docblock-short">Details how a parameter is malformed.</div></li><li><div class="item-name"><a class="enum" href="enum.UnsupportedErrorKind.html" title="enum image::error::UnsupportedErrorKind">Unsupported<wbr>Error<wbr>Kind</a></div><div class="desc docblock-short">Details what feature is not supported.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ImageResult.html" title="type image::error::ImageResult">Image<wbr>Result</a></div><div class="desc docblock-short">Result of an image decoding/encoding process</div></li></ul></section></div></main></body></html> |