| <!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="A converter that encodes a Unicode stream into bytes according to a character encoding in a streaming (incremental) manner."><meta name="keywords" content="rust, rustlang, rust-lang, Encoder"><title>Encoder in encoding_rs - 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 struct"><!--[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="../encoding_rs/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="../encoding_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Encoder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.encode_from_utf16">encode_from_utf16</a></li><li><a href="#method.encode_from_utf16_without_replacement">encode_from_utf16_without_replacement</a></li><li><a href="#method.encode_from_utf8">encode_from_utf8</a></li><li><a href="#method.encode_from_utf8_to_vec">encode_from_utf8_to_vec</a></li><li><a href="#method.encode_from_utf8_to_vec_without_replacement">encode_from_utf8_to_vec_without_replacement</a></li><li><a href="#method.encode_from_utf8_without_replacement">encode_from_utf8_without_replacement</a></li><li><a href="#method.encoding">encoding</a></li><li><a href="#method.has_pending_state">has_pending_state</a></li><li><a href="#method.max_buffer_length_from_utf16_if_no_unmappables">max_buffer_length_from_utf16_if_no_unmappables</a></li><li><a href="#method.max_buffer_length_from_utf16_without_replacement">max_buffer_length_from_utf16_without_replacement</a></li><li><a href="#method.max_buffer_length_from_utf8_if_no_unmappables">max_buffer_length_from_utf8_if_no_unmappables</a></li><li><a href="#method.max_buffer_length_from_utf8_without_replacement">max_buffer_length_from_utf8_without_replacement</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Encoder">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Encoder">Send</a></li><li><a href="#impl-Sync-for-Encoder">Sync</a></li><li><a href="#impl-Unpin-for-Encoder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Encoder">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Encoder">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Encoder">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Encoder">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Encoder">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Encoder">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Encoder">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Encoder">TryInto<U></a></li></ul></section><h2><a href="index.html">In encoding_rs</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">Struct <a href="index.html">encoding_rs</a>::<wbr><a class="struct" href="#">Encoder</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/encoding_rs/lib.rs.html#4481-4484">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 struct"><code>pub struct Encoder { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A converter that encodes a Unicode stream into bytes according to a |
| character encoding in a streaming (incremental) manner.</p> |
| <p>The various <code>encode_*</code> methods take an input buffer (<code>src</code>) and an output |
| buffer <code>dst</code> both of which are caller-allocated. There are variants for |
| both UTF-8 and UTF-16 input buffers.</p> |
| <p>An <code>encode_*</code> method encode characters from <code>src</code> into bytes characters |
| stored into <code>dst</code> until one of the following three things happens:</p> |
| <ol> |
| <li> |
| <p>An unmappable character is encountered (<code>*_without_replacement</code> variants |
| only).</p> |
| </li> |
| <li> |
| <p>The output buffer has been filled so near capacity that the decoder |
| cannot be sure that processing an additional character of input wouldn’t |
| cause so much output that the output buffer would overflow.</p> |
| </li> |
| <li> |
| <p>All the input characters have been processed.</p> |
| </li> |
| </ol> |
| <p>The <code>encode_*</code> method then returns tuple of a status indicating which one |
| of the three reasons to return happened, how many input code units (<code>u8</code> |
| when encoding from UTF-8 and <code>u16</code> when encoding from UTF-16) were read, |
| how many output bytes were written (except when encoding into <code>Vec<u8></code>, |
| whose length change indicates this), and in the case of the variants that |
| perform replacement, a boolean indicating whether an unmappable |
| character was replaced with a numeric character reference during the call.</p> |
| <p>The number of bytes “written” is what’s logically written. Garbage may be |
| written in the output buffer beyond the point logically written to.</p> |
| <p>In the case of the methods whose name ends with |
| <code>*_without_replacement</code>, the status is an <a href="enum.EncoderResult.html"><code>EncoderResult</code></a> enumeration |
| (possibilities <code>Unmappable</code>, <code>OutputFull</code> and <code>InputEmpty</code> corresponding to |
| the three cases listed above).</p> |
| <p>In the case of methods whose name does not end with |
| <code>*_without_replacement</code>, unmappable characters are automatically replaced |
| with the corresponding numeric character references and unmappable |
| characters do not cause the methods to return early.</p> |
| <p>When encoding from UTF-8 without replacement, the methods are guaranteed |
| not to return indicating that more output space is needed if the length |
| of the output buffer is at least the length returned by |
| <a href="#method.max_buffer_length_from_utf8_without_replacement"><code>max_buffer_length_from_utf8_without_replacement()</code></a>. When encoding from |
| UTF-8 with replacement, the length of the output buffer that guarantees the |
| methods not to return indicating that more output space is needed in the |
| absence of unmappable characters is given by |
| <a href="#method.max_buffer_length_from_utf8_if_no_unmappables"><code>max_buffer_length_from_utf8_if_no_unmappables()</code></a>. When encoding from |
| UTF-16 without replacement, the methods are guaranteed not to return |
| indicating that more output space is needed if the length of the output |
| buffer is at least the length returned by |
| <a href="#method.max_buffer_length_from_utf16_without_replacement"><code>max_buffer_length_from_utf16_without_replacement()</code></a>. When encoding |
| from UTF-16 with replacement, the the length of the output buffer that |
| guarantees the methods not to return indicating that more output space is |
| needed in the absence of unmappable characters is given by |
| <a href="#method.max_buffer_length_from_utf16_if_no_unmappables"><code>max_buffer_length_from_utf16_if_no_unmappables()</code></a>. |
| When encoding with replacement, applications are not expected to size the |
| buffer for the worst case ahead of time but to resize the buffer if there |
| are unmappable characters. This is why max length queries are only available |
| for the case where there are no unmappable characters.</p> |
| <p>When encoding from UTF-8, each <code>src</code> buffer <em>must</em> be valid UTF-8. (When |
| calling from Rust, the type system takes care of this.) When encoding from |
| UTF-16, unpaired surrogates in the input are treated as U+FFFD REPLACEMENT |
| CHARACTERS. Therefore, in order for astral characters not to turn into a |
| pair of REPLACEMENT CHARACTERS, the caller must ensure that surrogate pairs |
| are not split across input buffer boundaries.</p> |
| <p>After an <code>encode_*</code> call returns, the output produced so far, taken as a |
| whole from the start of the stream, is guaranteed to consist of a valid |
| byte sequence in the target encoding. (I.e. the code unit sequence for a |
| character is guaranteed not to be split across output buffers. However, due |
| to the stateful nature of ISO-2022-JP, the stream needs to be considered |
| from the start for it to be valid. For other encodings, the validity holds |
| on a per-output buffer basis.)</p> |
| <p>The boolean argument <code>last</code> indicates that the end of the stream is reached |
| when all the characters in <code>src</code> have been consumed. This argument is needed |
| for ISO-2022-JP and is ignored for other encodings.</p> |
| <p>An <code>Encoder</code> object can be used to incrementally encode a byte stream.</p> |
| <p>During the processing of a single stream, the caller must call <code>encode_*</code> |
| zero or more times with <code>last</code> set to <code>false</code> and then call <code>encode_*</code> at |
| least once with <code>last</code> set to <code>true</code>. If <code>encode_*</code> returns <code>InputEmpty</code>, |
| the processing of the stream has ended. Otherwise, the caller must call |
| <code>encode_*</code> again with <code>last</code> set to <code>true</code> (or treat an <code>Unmappable</code> result |
| as a fatal error).</p> |
| <p>Once the stream has ended, the <code>Encoder</code> object must not be used anymore. |
| That is, you need to create another one to process another stream.</p> |
| <p>When the encoder returns <code>OutputFull</code> or the encoder returns <code>Unmappable</code> |
| and the caller does not wish to treat it as a fatal error, the input buffer |
| <code>src</code> may not have been completely consumed. In that case, the caller must |
| pass the unconsumed contents of <code>src</code> to <code>encode_*</code> again upon the next |
| call.</p> |
| <h2 id="infinite-loops"><a href="#infinite-loops">Infinite loops</a></h2> |
| <p>When converting with a fixed-size output buffer whose size is too small to |
| accommodate one character of output, an infinite loop ensues. When |
| converting with a fixed-size output buffer, it generally makes sense to |
| make the buffer fairly large (e.g. couple of kilobytes).</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Encoder" class="impl has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4486-4835">source</a><a href="#impl-Encoder" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Encoder.html" title="struct encoding_rs::Encoder">Encoder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encoding" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4496-4498">source</a><h4 class="code-header">pub fn <a href="#method.encoding" class="fnname">encoding</a>(&self) -> &'static <a class="struct" href="struct.Encoding.html" title="struct encoding_rs::Encoding">Encoding</a></h4></section></summary><div class="docblock"><p>The <code>Encoding</code> this <code>Encoder</code> is for.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_pending_state" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4503-4505">source</a><h4 class="code-header">pub fn <a href="#method.has_pending_state" class="fnname">has_pending_state</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if this is an ISO-2022-JP encoder that’s not in the |
| ASCII state and <code>false</code> otherwise.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_buffer_length_from_utf8_if_no_unmappables" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4516-4528">source</a><h4 class="code-header">pub fn <a href="#method.max_buffer_length_from_utf8_if_no_unmappables" class="fnname">max_buffer_length_from_utf8_if_no_unmappables</a>(<br> &self,<br> byte_length: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Query the worst-case output size when encoding from UTF-8 with |
| replacement.</p> |
| <p>Returns the size of the output buffer in bytes that will not overflow |
| given the current state of the encoder and <code>byte_length</code> number of |
| additional input code units if there are no unmappable characters in |
| the input or <code>None</code> if <code>usize</code> would overflow.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_buffer_length_from_utf8_without_replacement" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4538-4544">source</a><h4 class="code-header">pub fn <a href="#method.max_buffer_length_from_utf8_without_replacement" class="fnname">max_buffer_length_from_utf8_without_replacement</a>(<br> &self,<br> byte_length: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Query the worst-case output size when encoding from UTF-8 without |
| replacement.</p> |
| <p>Returns the size of the output buffer in bytes that will not overflow |
| given the current state of the encoder and <code>byte_length</code> number of |
| additional input code units or <code>None</code> if <code>usize</code> would overflow.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_from_utf8" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4553-4626">source</a><h4 class="code-header">pub fn <a href="#method.encode_from_utf8" class="fnname">encode_from_utf8</a>(<br> &mut self,<br> src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> dst: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>],<br> last: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a><br>) -> (<a class="enum" href="enum.CoderResult.html" title="enum encoding_rs::CoderResult">CoderResult</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a>)</h4></section></summary><div class="docblock"><p>Incrementally encode into byte stream from UTF-8 with unmappable |
| characters replaced with HTML (decimal) numeric character references.</p> |
| <p>See the documentation of the struct for documentation for <code>encode_*</code> |
| methods collectively.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_from_utf8_to_vec" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4637-4652">source</a><h4 class="code-header">pub fn <a href="#method.encode_from_utf8_to_vec" class="fnname">encode_from_utf8_to_vec</a>(<br> &mut self,<br> src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>>,<br> last: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a><br>) -> (<a class="enum" href="enum.CoderResult.html" title="enum encoding_rs::CoderResult">CoderResult</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a>)</h4></section></summary><div class="docblock"><p>Incrementally encode into byte stream from UTF-8 with unmappable |
| characters replaced with HTML (decimal) numeric character references.</p> |
| <p>See the documentation of the struct for documentation for <code>encode_*</code> |
| methods collectively.</p> |
| <p>Available to Rust only and only with the <code>alloc</code> feature enabled (enabled |
| by default).</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_from_utf8_without_replacement" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4660-4667">source</a><h4 class="code-header">pub fn <a href="#method.encode_from_utf8_without_replacement" class="fnname">encode_from_utf8_without_replacement</a>(<br> &mut self,<br> src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> dst: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>],<br> last: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a><br>) -> (<a class="enum" href="enum.EncoderResult.html" title="enum encoding_rs::EncoderResult">EncoderResult</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Incrementally encode into byte stream from UTF-8 <em>without replacement</em>.</p> |
| <p>See the documentation of the struct for documentation for <code>encode_*</code> |
| methods collectively.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_from_utf8_to_vec_without_replacement" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4677-4692">source</a><h4 class="code-header">pub fn <a href="#method.encode_from_utf8_to_vec_without_replacement" class="fnname">encode_from_utf8_to_vec_without_replacement</a>(<br> &mut self,<br> src: &<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.str.html">str</a>,<br> dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>>,<br> last: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a><br>) -> (<a class="enum" href="enum.EncoderResult.html" title="enum encoding_rs::EncoderResult">EncoderResult</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Incrementally encode into byte stream from UTF-8 <em>without replacement</em>.</p> |
| <p>See the documentation of the struct for documentation for <code>encode_*</code> |
| methods collectively.</p> |
| <p>Available to Rust only and only with the <code>alloc</code> feature enabled (enabled |
| by default).</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_buffer_length_from_utf16_if_no_unmappables" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4703-4715">source</a><h4 class="code-header">pub fn <a href="#method.max_buffer_length_from_utf16_if_no_unmappables" class="fnname">max_buffer_length_from_utf16_if_no_unmappables</a>(<br> &self,<br> u16_length: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Query the worst-case output size when encoding from UTF-16 with |
| replacement.</p> |
| <p>Returns the size of the output buffer in bytes that will not overflow |
| given the current state of the encoder and <code>u16_length</code> number of |
| additional input code units if there are no unmappable characters in |
| the input or <code>None</code> if <code>usize</code> would overflow.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_buffer_length_from_utf16_without_replacement" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4725-4731">source</a><h4 class="code-header">pub fn <a href="#method.max_buffer_length_from_utf16_without_replacement" class="fnname">max_buffer_length_from_utf16_without_replacement</a>(<br> &self,<br> u16_length: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Query the worst-case output size when encoding from UTF-16 without |
| replacement.</p> |
| <p>Returns the size of the output buffer in bytes that will not overflow |
| given the current state of the encoder and <code>u16_length</code> number of |
| additional input code units or <code>None</code> if <code>usize</code> would overflow.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_from_utf16" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4740-4819">source</a><h4 class="code-header">pub fn <a href="#method.encode_from_utf16" class="fnname">encode_from_utf16</a>(<br> &mut self,<br> src: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u16.html">u16</a>],<br> dst: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>],<br> last: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a><br>) -> (<a class="enum" href="enum.CoderResult.html" title="enum encoding_rs::CoderResult">CoderResult</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a>)</h4></section></summary><div class="docblock"><p>Incrementally encode into byte stream from UTF-16 with unmappable |
| characters replaced with HTML (decimal) numeric character references.</p> |
| <p>See the documentation of the struct for documentation for <code>encode_*</code> |
| methods collectively.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.encode_from_utf16_without_replacement" class="method has-srclink"><a class="srclink rightside" href="../src/encoding_rs/lib.rs.html#4827-4834">source</a><h4 class="code-header">pub fn <a href="#method.encode_from_utf16_without_replacement" class="fnname">encode_from_utf16_without_replacement</a>(<br> &mut self,<br> src: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u16.html">u16</a>],<br> dst: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.u8.html">u8</a>],<br> last: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.bool.html">bool</a><br>) -> (<a class="enum" href="enum.EncoderResult.html" title="enum encoding_rs::EncoderResult">EncoderResult</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Incrementally encode into byte stream from UTF-16 <em>without replacement</em>.</p> |
| <p>See the documentation of the struct for documentation for <code>encode_*</code> |
| methods collectively.</p> |
| <p>Available via the C wrapper.</p> |
| </div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Encoder" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Encoder" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Encoder.html" title="struct encoding_rs::Encoder">Encoder</a></h3></section><section id="impl-Send-for-Encoder" class="impl has-srclink"><a href="#impl-Send-for-Encoder" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Encoder.html" title="struct encoding_rs::Encoder">Encoder</a></h3></section><section id="impl-Sync-for-Encoder" class="impl has-srclink"><a href="#impl-Sync-for-Encoder" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Encoder.html" title="struct encoding_rs::Encoder">Encoder</a></h3></section><section id="impl-Unpin-for-Encoder" class="impl has-srclink"><a href="#impl-Unpin-for-Encoder" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Encoder.html" title="struct encoding_rs::Encoder">Encoder</a></h3></section><section id="impl-UnwindSafe-for-Encoder" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Encoder" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Encoder.html" title="struct encoding_rs::Encoder">Encoder</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Encoder" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Encoder" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="encoding_rs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
