| <!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="The trait all encoders implement"><meta name="keywords" content="rust, rustlang, rust-lang, ImageEncoder"><title>ImageEncoder in image - 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="sidebar-items.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 trait"><!--[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="#">ImageEncoder</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.write_image">write_image</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In image</a></h2></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">Trait <a href="index.html">image</a>::<wbr><a class="trait" href="#">ImageEncoder</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/image.rs.html#666-684">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ImageEncoder { |
| fn <a href="#tymethod.write_image" class="fnname">write_image</a>(<br> self,<br> buf: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],<br> width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,<br> height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,<br> color_type: <a class="enum" href="enum.ColorType.html" title="enum image::ColorType">ColorType</a><br> ) -> <a class="type" href="error/type.ImageResult.html" title="type image::error::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The trait all encoders implement</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_image" class="method has-srclink"><a class="srclink rightside" href="../src/image/image.rs.html#677-683">source</a><h4 class="code-header">fn <a href="#tymethod.write_image" class="fnname">write_image</a>(<br> self,<br> buf: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>],<br> width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,<br> height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,<br> color_type: <a class="enum" href="enum.ColorType.html" title="enum image::ColorType">ColorType</a><br>) -> <a class="type" href="error/type.ImageResult.html" title="type image::error::ImageResult">ImageResult</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Writes all the bytes in an image to the encoder.</p> |
| <p>This function takes a slice of bytes of the pixel data of the image |
| and encodes them. Unlike particular format encoders inherent impl encode |
| methods where endianness is not specified, here image data bytes should |
| always be in native endian. The implementor will reorder the endianess |
| as necessary for the target encoding format.</p> |
| <p>See also <code>ImageDecoder::read_image</code> which reads byte buffers into |
| native endian.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-ImageEncoder-for-JpegEncoder%3C%27a%2C%20W%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/image/codecs/jpeg/encoder.rs.html#677-687">source</a><a href="#impl-ImageEncoder-for-JpegEncoder%3C%27a%2C%20W%3E" class="anchor"></a><h3 class="code-header">impl<'a, W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>> <a class="trait" href="trait.ImageEncoder.html" title="trait image::ImageEncoder">ImageEncoder</a> for <a class="struct" href="codecs/jpeg/struct.JpegEncoder.html" title="struct image::codecs::jpeg::JpegEncoder">JpegEncoder</a><'a, W></h3></section></div><script src="../implementors/image/image/trait.ImageEncoder.js" async></script></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> |
