summaryrefslogtreecommitdiffstats
path: root/third_party/rust/encoding_rs/src/lib.rs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/rust/encoding_rs/src/lib.rs
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/encoding_rs/src/lib.rs')
-rw-r--r--third_party/rust/encoding_rs/src/lib.rs6133
1 files changed, 6133 insertions, 0 deletions
diff --git a/third_party/rust/encoding_rs/src/lib.rs b/third_party/rust/encoding_rs/src/lib.rs
new file mode 100644
index 0000000000..6cc920ef88
--- /dev/null
+++ b/third_party/rust/encoding_rs/src/lib.rs
@@ -0,0 +1,6133 @@
+// Copyright Mozilla Foundation. See the COPYRIGHT
+// file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+#![cfg_attr(
+ feature = "cargo-clippy",
+ allow(doc_markdown, inline_always, new_ret_no_self)
+)]
+
+//! encoding_rs is a Gecko-oriented Free Software / Open Source implementation
+//! of the [Encoding Standard](https://encoding.spec.whatwg.org/) in Rust.
+//! Gecko-oriented means that converting to and from UTF-16 is supported in
+//! addition to converting to and from UTF-8, that the performance and
+//! streamability goals are browser-oriented, and that FFI-friendliness is a
+//! goal.
+//!
+//! Additionally, the `mem` module provides functions that are useful for
+//! applications that need to be able to deal with legacy in-memory
+//! representations of Unicode.
+//!
+//! For expectation setting, please be sure to read the sections
+//! [_UTF-16LE, UTF-16BE and Unicode Encoding Schemes_](#utf-16le-utf-16be-and-unicode-encoding-schemes),
+//! [_ISO-8859-1_](#iso-8859-1) and [_Web / Browser Focus_](#web--browser-focus) below.
+//!
+//! There is a [long-form write-up](https://hsivonen.fi/encoding_rs/) about the
+//! design and internals of the crate.
+//!
+//! # Availability
+//!
+//! The code is available under the
+//! [Apache license, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+//! or the [MIT license](https://opensource.org/licenses/MIT), at your option.
+//! See the
+//! [`COPYRIGHT`](https://github.com/hsivonen/encoding_rs/blob/master/COPYRIGHT)
+//! file for details.
+//! The [repository is on GitHub](https://github.com/hsivonen/encoding_rs). The
+//! [crate is available on crates.io](https://crates.io/crates/encoding_rs).
+//!
+//! # Integration with `std::io`
+//!
+//! This crate doesn't implement traits from `std::io`. However, for the case of
+//! wrapping a `std::io::Read` in a decoder that implements `std::io::Read` and
+//! presents the data from the wrapped `std::io::Read` as UTF-8 is addressed by
+//! the [`encoding_rs_io`](https://docs.rs/encoding_rs_io/) crate.
+//!
+//! # Examples
+//!
+//! Example programs:
+//!
+//! * [Rust](https://github.com/hsivonen/recode_rs)
+//! * [C](https://github.com/hsivonen/recode_c)
+//! * [C++](https://github.com/hsivonen/recode_cpp)
+//!
+//! Decode using the non-streaming API:
+//!
+//! ```
+//! #[cfg(feature = "alloc")] {
+//! use encoding_rs::*;
+//!
+//! let expectation = "\u{30CF}\u{30ED}\u{30FC}\u{30FB}\u{30EF}\u{30FC}\u{30EB}\u{30C9}";
+//! let bytes = b"\x83n\x83\x8D\x81[\x81E\x83\x8F\x81[\x83\x8B\x83h";
+//!
+//! let (cow, encoding_used, had_errors) = SHIFT_JIS.decode(bytes);
+//! assert_eq!(&cow[..], expectation);
+//! assert_eq!(encoding_used, SHIFT_JIS);
+//! assert!(!had_errors);
+//! }
+//! ```
+//!
+//! Decode using the streaming API with minimal `unsafe`:
+//!
+//! ```
+//! use encoding_rs::*;
+//!
+//! let expectation = "\u{30CF}\u{30ED}\u{30FC}\u{30FB}\u{30EF}\u{30FC}\u{30EB}\u{30C9}";
+//!
+//! // Use an array of byte slices to demonstrate content arriving piece by
+//! // piece from the network.
+//! let bytes: [&'static [u8]; 4] = [b"\x83",
+//! b"n\x83\x8D\x81",
+//! b"[\x81E\x83\x8F\x81[\x83",
+//! b"\x8B\x83h"];
+//!
+//! // Very short output buffer to demonstrate the output buffer getting full.
+//! // Normally, you'd use something like `[0u8; 2048]`.
+//! let mut buffer_bytes = [0u8; 8];
+//! let mut buffer: &mut str = std::str::from_utf8_mut(&mut buffer_bytes[..]).unwrap();
+//!
+//! // How many bytes in the buffer currently hold significant data.
+//! let mut bytes_in_buffer = 0usize;
+//!
+//! // Collect the output to a string for demonstration purposes.
+//! let mut output = String::new();
+//!
+//! // The `Decoder`
+//! let mut decoder = SHIFT_JIS.new_decoder();
+//!
+//! // Track whether we see errors.
+//! let mut total_had_errors = false;
+//!
+//! // Decode using a fixed-size intermediate buffer (for demonstrating the
+//! // use of a fixed-size buffer; normally when the output of an incremental
+//! // decode goes to a `String` one would use `Decoder.decode_to_string()` to
+//! // avoid the intermediate buffer).
+//! for input in &bytes[..] {
+//! // The number of bytes already read from current `input` in total.
+//! let mut total_read_from_current_input = 0usize;
+//!
+//! loop {
+//! let (result, read, written, had_errors) =
+//! decoder.decode_to_str(&input[total_read_from_current_input..],
+//! &mut buffer[bytes_in_buffer..],
+//! false);
+//! total_read_from_current_input += read;
+//! bytes_in_buffer += written;
+//! total_had_errors |= had_errors;
+//! match result {
+//! CoderResult::InputEmpty => {
+//! // We have consumed the current input buffer. Break out of
+//! // the inner loop to get the next input buffer from the
+//! // outer loop.
+//! break;
+//! },
+//! CoderResult::OutputFull => {
+//! // Write the current buffer out and consider the buffer
+//! // empty.
+//! output.push_str(&buffer[..bytes_in_buffer]);
+//! bytes_in_buffer = 0usize;
+//! continue;
+//! }
+//! }
+//! }
+//! }
+//!
+//! // Process EOF
+//! loop {
+//! let (result, _, written, had_errors) =
+//! decoder.decode_to_str(b"",
+//! &mut buffer[bytes_in_buffer..],
+//! true);
+//! bytes_in_buffer += written;
+//! total_had_errors |= had_errors;
+//! // Write the current buffer out and consider the buffer empty.
+//! // Need to do this here for both `match` arms, because we exit the
+//! // loop on `CoderResult::InputEmpty`.
+//! output.push_str(&buffer[..bytes_in_buffer]);
+//! bytes_in_buffer = 0usize;
+//! match result {
+//! CoderResult::InputEmpty => {
+//! // Done!
+//! break;
+//! },
+//! CoderResult::OutputFull => {
+//! continue;
+//! }
+//! }
+//! }
+//!
+//! assert_eq!(&output[..], expectation);
+//! assert!(!total_had_errors);
+//! ```
+//!
+//! ## UTF-16LE, UTF-16BE and Unicode Encoding Schemes
+//!
+//! The Encoding Standard doesn't specify encoders for UTF-16LE and UTF-16BE,
+//! __so this crate does not provide encoders for those encodings__!
+//! Along with the replacement encoding, their _output encoding_ (i.e. the
+//! encoding used for form submission and error handling in the query string
+//! of URLs) is UTF-8, so you get an UTF-8 encoder if you request an encoder
+//! for them.
+//!
+//! Additionally, the Encoding Standard factors BOM handling into wrapper
+//! algorithms so that BOM handling isn't part of the definition of the
+//! encodings themselves. The Unicode _encoding schemes_ in the Unicode
+//! Standard define BOM handling or lack thereof as part of the encoding
+//! scheme.
+//!
+//! When used with the `_without_bom_handling` entry points, the UTF-16LE
+//! and UTF-16BE _encodings_ match the same-named _encoding schemes_ from
+//! the Unicode Standard.
+//!
+//! When used with the `_with_bom_removal` entry points, the UTF-8
+//! _encoding_ matches the UTF-8 _encoding scheme_ from the Unicode
+//! Standard.
+//!
+//! This crate does not provide a mode that matches the UTF-16 _encoding
+//! scheme_ from the Unicode Stardard. The UTF-16BE encoding used with
+//! the entry points without `_bom_` qualifiers is the closest match,
+//! but in that case, the UTF-8 BOM triggers UTF-8 decoding, which is
+//! not part of the behavior of the UTF-16 _encoding scheme_ per the
+//! Unicode Standard.
+//!
+//! The UTF-32 family of Unicode encoding schemes is not supported
+//! by this crate. The Encoding Standard doesn't define any UTF-32
+//! family encodings, since they aren't necessary for consuming Web
+//! content.
+//!
+//! While gb18030 is capable of representing U+FEFF, the Encoding
+//! Standard does not treat the gb18030 byte representation of U+FEFF
+//! as a BOM, so neither does this crate.
+//!
+//! ## ISO-8859-1
+//!
+//! ISO-8859-1 does not exist as a distinct encoding from windows-1252 in
+//! the Encoding Standard. Therefore, an encoding that maps the unsigned
+//! byte value to the same Unicode scalar value is not available via
+//! `Encoding` in this crate.
+//!
+//! However, the functions whose name starts with `convert` and contains
+//! `latin1` in the `mem` module support such conversions, which are known as
+//! [_isomorphic decode_](https://infra.spec.whatwg.org/#isomorphic-decode)
+//! and [_isomorphic encode_](https://infra.spec.whatwg.org/#isomorphic-encode)
+//! in the [Infra Standard](https://infra.spec.whatwg.org/).
+//!
+//! ## Web / Browser Focus
+//!
+//! Both in terms of scope and performance, the focus is on the Web. For scope,
+//! this means that encoding_rs implements the Encoding Standard fully and
+//! doesn't implement encodings that are not specified in the Encoding
+//! Standard. For performance, this means that decoding performance is
+//! important as well as performance for encoding into UTF-8 or encoding the
+//! Basic Latin range (ASCII) into legacy encodings. Non-Basic Latin needs to
+//! be encoded into legacy encodings in only two places in the Web platform: in
+//! the query part of URLs, in which case it's a matter of relatively rare
+//! error handling, and in form submission, in which case the user action and
+//! networking tend to hide the performance of the encoder.
+//!
+//! Deemphasizing performance of encoding non-Basic Latin text into legacy
+//! encodings enables smaller code size thanks to the encoder side using the
+//! decode-optimized data tables without having encode-optimized data tables at
+//! all. Even in decoders, smaller lookup table size is preferred over avoiding
+//! multiplication operations.
+//!
+//! Additionally, performance is a non-goal for the ASCII-incompatible
+//! ISO-2022-JP encoding, which are rarely used on the Web. Instead of
+//! performance, the decoder for ISO-2022-JP optimizes for ease/clarity
+//! of implementation.
+//!
+//! Despite the browser focus, the hope is that non-browser applications
+//! that wish to consume Web content or submit Web forms in a Web-compatible
+//! way will find encoding_rs useful. While encoding_rs does not try to match
+//! Windows behavior, many of the encodings are close enough to legacy
+//! encodings implemented by Windows that applications that need to consume
+//! data in legacy Windows encodins may find encoding_rs useful. The
+//! [codepage](https://crates.io/crates/codepage) crate maps from Windows
+//! code page identifiers onto encoding_rs `Encoding`s and vice versa.
+//!
+//! For decoding email, UTF-7 support is needed (unfortunately) in additition
+//! to the encodings defined in the Encoding Standard. The
+//! [charset](https://crates.io/crates/charset) wraps encoding_rs and adds
+//! UTF-7 decoding for email purposes.
+//!
+//! For single-byte DOS encodings beyond the ones supported by the Encoding
+//! Standard, there is the [`oem_cp`](https://crates.io/crates/oem_cp) crate.
+//!
+//! # Preparing Text for the Encoders
+//!
+//! Normalizing text into Unicode Normalization Form C prior to encoding text
+//! into a legacy encoding minimizes unmappable characters. Text can be
+//! normalized to Unicode Normalization Form C using the
+//! [`icu_normalizer`](https://crates.io/crates/icu_normalizer) crate, which
+//! is part of [ICU4X](https://icu4x.unicode.org/).
+//!
+//! The exception is windows-1258, which after normalizing to Unicode
+//! Normalization Form C requires tone marks to be decomposed in order to
+//! minimize unmappable characters. Vietnamese tone marks can be decomposed
+//! using the [`detone`](https://crates.io/crates/detone) crate.
+//!
+//! # Streaming & Non-Streaming; Rust & C/C++
+//!
+//! The API in Rust has two modes of operation: streaming and non-streaming.
+//! The streaming API is the foundation of the implementation and should be
+//! used when processing data that arrives piecemeal from an i/o stream. The
+//! streaming API has an FFI wrapper (as a [separate crate][1]) that exposes it
+//! to C callers. The non-streaming part of the API is for Rust callers only and
+//! is smart about borrowing instead of copying when possible. When
+//! streamability is not needed, the non-streaming API should be preferrer in
+//! order to avoid copying data when a borrow suffices.
+//!
+//! There is no analogous C API exposed via FFI, mainly because C doesn't have
+//! standard types for growable byte buffers and Unicode strings that know
+//! their length.
+//!
+//! The C API (header file generated at `target/include/encoding_rs.h` when
+//! building encoding_rs) can, in turn, be wrapped for use from C++. Such a
+//! C++ wrapper can re-create the non-streaming API in C++ for C++ callers.
+//! The C binding comes with a [C++17 wrapper][2] that uses standard library +
+//! [GSL][3] types and that recreates the non-streaming API in C++ on top of
+//! the streaming API. A C++ wrapper with XPCOM/MFBT types is available as
+//! [`mozilla::Encoding`][4].
+//!
+//! The `Encoding` type is common to both the streaming and non-streaming
+//! modes. In the streaming mode, decoding operations are performed with a
+//! `Decoder` and encoding operations with an `Encoder` object obtained via
+//! `Encoding`. In the non-streaming mode, decoding and encoding operations are
+//! performed using methods on `Encoding` objects themselves, so the `Decoder`
+//! and `Encoder` objects are not used at all.
+//!
+//! [1]: https://github.com/hsivonen/encoding_c
+//! [2]: https://github.com/hsivonen/encoding_c/blob/master/include/encoding_rs_cpp.h
+//! [3]: https://github.com/Microsoft/GSL/
+//! [4]: https://searchfox.org/mozilla-central/source/intl/Encoding.h
+//!
+//! # Memory management
+//!
+//! The non-streaming mode never performs heap allocations (even the methods
+//! that write into a `Vec<u8>` or a `String` by taking them as arguments do
+//! not reallocate the backing buffer of the `Vec<u8>` or the `String`). That
+//! is, the non-streaming mode uses caller-allocated buffers exclusively.
+//!
+//! The methods of the streaming mode that return a `Vec<u8>` or a `String`
+//! perform heap allocations but only to allocate the backing buffer of the
+//! `Vec<u8>` or the `String`.
+//!
+//! `Encoding` is always statically allocated. `Decoder` and `Encoder` need no
+//! `Drop` cleanup.
+//!
+//! # Buffer reading and writing behavior
+//!
+//! Based on experience gained with the `java.nio.charset` encoding converter
+//! API and with the Gecko uconv encoding converter API, the buffer reading
+//! and writing behaviors of encoding_rs are asymmetric: input buffers are
+//! fully drained but output buffers are not always fully filled.
+//!
+//! When reading from an input buffer, encoding_rs always consumes all input
+//! up to the next error or to the end of the buffer. In particular, when
+//! decoding, even if the input buffer ends in the middle of a byte sequence
+//! for a character, the decoder consumes all input. This has the benefit that
+//! the caller of the API can always fill the next buffer from the start from
+//! whatever source the bytes come from and never has to first copy the last
+//! bytes of the previous buffer to the start of the next buffer. However, when
+//! encoding, the UTF-8 input buffers have to end at a character boundary, which
+//! is a requirement for the Rust `str` type anyway, and UTF-16 input buffer
+//! boundaries falling in the middle of a surrogate pair result in both
+//! suggorates being treated individually as unpaired surrogates.
+//!
+//! Additionally, decoders guarantee that they can be fed even one byte at a
+//! time and encoders guarantee that they can be fed even one code point at a
+//! time. This has the benefit of not placing restrictions on the size of
+//! chunks the content arrives e.g. from network.
+//!
+//! When writing into an output buffer, encoding_rs makes sure that the code
+//! unit sequence for a character is never split across output buffer
+//! boundaries. This may result in wasted space at the end of an output buffer,
+//! but the advantages are that the output side of both decoders and encoders
+//! is greatly simplified compared to designs that attempt to fill output
+//! buffers exactly even when that entails splitting a code unit sequence and
+//! when encoding_rs methods return to the caller, the output produces thus
+//! far is always valid taken as whole. (In the case of encoding to ISO-2022-JP,
+//! the output needs to be considered as a whole, because the latest output
+//! buffer taken alone might not be valid taken alone if the transition away
+//! from the ASCII state occurred in an earlier output buffer. However, since
+//! the ISO-2022-JP decoder doesn't treat streams that don't end in the ASCII
+//! state as being in error despite the encoder generating a transition to the
+//! ASCII state at the end, the claim about the partial output taken as a whole
+//! being valid is true even for ISO-2022-JP.)
+//!
+//! # Error Reporting
+//!
+//! Based on experience gained with the `java.nio.charset` encoding converter
+//! API and with the Gecko uconv encoding converter API, the error reporting
+//! behaviors of encoding_rs are asymmetric: decoder errors include offsets
+//! that leave it up to the caller to extract the erroneous bytes from the
+//! input stream if the caller wishes to do so but encoder errors provide the
+//! code point associated with the error without requiring the caller to
+//! extract it from the input on its own.
+//!
+//! On the encoder side, an error is always triggered by the most recently
+//! pushed Unicode scalar, which makes it simple to pass the `char` to the
+//! caller. Also, it's very typical for the caller to wish to do something with
+//! this data: generate a numeric escape for the character. Additionally, the
+//! ISO-2022-JP encoder reports U+FFFD instead of the actual input character in
+//! certain cases, so requiring the caller to extract the character from the
+//! input buffer would require the caller to handle ISO-2022-JP details.
+//! Furthermore, requiring the caller to extract the character from the input
+//! buffer would require the caller to implement UTF-8 or UTF-16 math, which is
+//! the job of an encoding conversion library.
+//!
+//! On the decoder side, errors are triggered in more complex ways. For
+//! example, when decoding the sequence ESC, '$', _buffer boundary_, 'A' as
+//! ISO-2022-JP, the ESC byte is in error, but this is discovered only after
+//! the buffer boundary when processing 'A'. Thus, the bytes in error might not
+//! be the ones most recently pushed to the decoder and the error might not even
+//! be in the current buffer.
+//!
+//! Some encoding conversion APIs address the problem by not acknowledging
+//! trailing bytes of an input buffer as consumed if it's still possible for
+//! future bytes to cause the trailing bytes to be in error. This way, error
+//! reporting can always refer to the most recently pushed buffer. This has the
+//! problem that the caller of the API has to copy the unconsumed trailing
+//! bytes to the start of the next buffer before being able to fill the rest
+//! of the next buffer. This is annoying, error-prone and inefficient.
+//!
+//! A possible solution would be making the decoder remember recently consumed
+//! bytes in order to be able to include a copy of the erroneous bytes when
+//! reporting an error. This has two problem: First, callers a rarely
+//! interested in the erroneous bytes, so attempts to identify them are most
+//! often just overhead anyway. Second, the rare applications that are
+//! interested typically care about the location of the error in the input
+//! stream.
+//!
+//! To keep the API convenient for common uses and the overhead low while making
+//! it possible to develop applications, such as HTML validators, that care
+//! about which bytes were in error, encoding_rs reports the length of the
+//! erroneous sequence and the number of bytes consumed after the erroneous
+//! sequence. As long as the caller doesn't discard the 6 most recent bytes,
+//! this makes it possible for callers that care about the erroneous bytes to
+//! locate them.
+//!
+//! # No Convenience API for Custom Replacements
+//!
+//! The Web Platform and, therefore, the Encoding Standard supports only one
+//! error recovery mode for decoders and only one error recovery mode for
+//! encoders. The supported error recovery mode for decoders is emitting the
+//! REPLACEMENT CHARACTER on error. The supported error recovery mode for
+//! encoders is emitting an HTML decimal numeric character reference for
+//! unmappable characters.
+//!
+//! Since encoding_rs is Web-focused, these are the only error recovery modes
+//! for which convenient support is provided. Moreover, on the decoder side,
+//! there aren't really good alternatives for emitting the REPLACEMENT CHARACTER
+//! on error (other than treating errors as fatal). In particular, simply
+//! ignoring errors is a
+//! [security problem](http://www.unicode.org/reports/tr36/#Substituting_for_Ill_Formed_Subsequences),
+//! so it would be a bad idea for encoding_rs to provide a mode that encouraged
+//! callers to ignore errors.
+//!
+//! On the encoder side, there are plausible alternatives for HTML decimal
+//! numeric character references. For example, when outputting CSS, CSS-style
+//! escapes would seem to make sense. However, instead of facilitating the
+//! output of CSS, JS, etc. in non-UTF-8 encodings, encoding_rs takes the design
+//! position that you shouldn't generate output in encodings other than UTF-8,
+//! except where backward compatibility with interacting with the legacy Web
+//! requires it. The legacy Web requires it only when parsing the query strings
+//! of URLs and when submitting forms, and those two both use HTML decimal
+//! numeric character references.
+//!
+//! While encoding_rs doesn't make encoder replacements other than HTML decimal
+//! numeric character references easy, it does make them _possible_.
+//! `encode_from_utf8()`, which emits HTML decimal numeric character references
+//! for unmappable characters, is implemented on top of
+//! `encode_from_utf8_without_replacement()`. Applications that really, really
+//! want other replacement schemes for unmappable characters can likewise
+//! implement them on top of `encode_from_utf8_without_replacement()`.
+//!
+//! # No Extensibility by Design
+//!
+//! The set of encodings supported by encoding_rs is not extensible by design.
+//! That is, `Encoding`, `Decoder` and `Encoder` are intentionally `struct`s
+//! rather than `trait`s. encoding_rs takes the design position that all future
+//! text interchange should be done using UTF-8, which can represent all of
+//! Unicode. (It is, in fact, the only encoding supported by the Encoding
+//! Standard and encoding_rs that can represent all of Unicode and that has
+//! encoder support. UTF-16LE and UTF-16BE don't have encoder support, and
+//! gb18030 cannot encode U+E5E5.) The other encodings are supported merely for
+//! legacy compatibility and not due to non-UTF-8 encodings having benefits
+//! other than being able to consume legacy content.
+//!
+//! Considering that UTF-8 can represent all of Unicode and is already supported
+//! by all Web browsers, introducing a new encoding wouldn't add to the
+//! expressiveness but would add to compatibility problems. In that sense,
+//! adding new encodings to the Web Platform doesn't make sense, and, in fact,
+//! post-UTF-8 attempts at encodings, such as BOCU-1, have been rejected from
+//! the Web Platform. On the other hand, the set of legacy encodings that must
+//! be supported for a Web browser to be able to be successful is not going to
+//! expand. Empirically, the set of encodings specified in the Encoding Standard
+//! is already sufficient and the set of legacy encodings won't grow
+//! retroactively.
+//!
+//! Since extensibility doesn't make sense considering the Web focus of
+//! encoding_rs and adding encodings to Web clients would be actively harmful,
+//! it makes sense to make the set of encodings that encoding_rs supports
+//! non-extensible and to take the (admittedly small) benefits arising from
+//! that, such as the size of `Decoder` and `Encoder` objects being known ahead
+//! of time, which enables stack allocation thereof.
+//!
+//! This does have downsides for applications that might want to put encoding_rs
+//! to non-Web uses if those non-Web uses involve legacy encodings that aren't
+//! needed for Web uses. The needs of such applications should not complicate
+//! encoding_rs itself, though. It is up to those applications to provide a
+//! framework that delegates the operations with encodings that encoding_rs
+//! supports to encoding_rs and operations with other encodings to something
+//! else (as opposed to encoding_rs itself providing an extensibility
+//! framework).
+//!
+//! # Panics
+//!
+//! Methods in encoding_rs can panic if the API is used against the requirements
+//! stated in the documentation, if a state that's supposed to be impossible
+//! is reached due to an internal bug or on integer overflow. When used
+//! according to documentation with buffer sizes that stay below integer
+//! overflow, in the absence of internal bugs, encoding_rs does not panic.
+//!
+//! Panics arising from API misuse aren't documented beyond this on individual
+//! methods.
+//!
+//! # At-Risk Parts of the API
+//!
+//! The foreseeable source of partially backward-incompatible API change is the
+//! way the instances of `Encoding` are made available.
+//!
+//! If Rust changes to allow the entries of `[&'static Encoding; N]` to be
+//! initialized with `static`s of type `&'static Encoding`, the non-reference
+//! `FOO_INIT` public `Encoding` instances will be removed from the public API.
+//!
+//! If Rust changes to make the referent of `pub const FOO: &'static Encoding`
+//! unique when the constant is used in different crates, the reference-typed
+//! `static`s for the encoding instances will be changed from `static` to
+//! `const` and the non-reference-typed `_INIT` instances will be removed.
+//!
+//! # Mapping Spec Concepts onto the API
+//!
+//! <table>
+//! <thead>
+//! <tr><th>Spec Concept</th><th>Streaming</th><th>Non-Streaming</th></tr>
+//! </thead>
+//! <tbody>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#encoding">encoding</a></td><td><code>&amp;'static Encoding</code></td><td><code>&amp;'static Encoding</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#utf-8">UTF-8 encoding</a></td><td><code>UTF_8</code></td><td><code>UTF_8</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#concept-encoding-get">get an encoding</a></td><td><code>Encoding::for_label(<var>label</var>)</code></td><td><code>Encoding::for_label(<var>label</var>)</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#name">name</a></td><td><code><var>encoding</var>.name()</code></td><td><code><var>encoding</var>.name()</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#get-an-output-encoding">get an output encoding</a></td><td><code><var>encoding</var>.output_encoding()</code></td><td><code><var>encoding</var>.output_encoding()</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#decode">decode</a></td><td><code>let d = <var>encoding</var>.new_decoder();<br>let res = d.decode_to_<var>*</var>(<var>src</var>, <var>dst</var>, false);<br>// &hellip;</br>let last_res = d.decode_to_<var>*</var>(<var>src</var>, <var>dst</var>, true);</code></td><td><code><var>encoding</var>.decode(<var>src</var>)</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#utf-8-decode">UTF-8 decode</a></td><td><code>let d = UTF_8.new_decoder_with_bom_removal();<br>let res = d.decode_to_<var>*</var>(<var>src</var>, <var>dst</var>, false);<br>// &hellip;</br>let last_res = d.decode_to_<var>*</var>(<var>src</var>, <var>dst</var>, true);</code></td><td><code>UTF_8.decode_with_bom_removal(<var>src</var>)</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#utf-8-decode-without-bom">UTF-8 decode without BOM</a></td><td><code>let d = UTF_8.new_decoder_without_bom_handling();<br>let res = d.decode_to_<var>*</var>(<var>src</var>, <var>dst</var>, false);<br>// &hellip;</br>let last_res = d.decode_to_<var>*</var>(<var>src</var>, <var>dst</var>, true);</code></td><td><code>UTF_8.decode_without_bom_handling(<var>src</var>)</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#utf-8-decode-without-bom-or-fail">UTF-8 decode without BOM or fail</a></td><td><code>let d = UTF_8.new_decoder_without_bom_handling();<br>let res = d.decode_to_<var>*</var>_without_replacement(<var>src</var>, <var>dst</var>, false);<br>// &hellip; (fail if malformed)</br>let last_res = d.decode_to_<var>*</var>_without_replacement(<var>src</var>, <var>dst</var>, true);<br>// (fail if malformed)</code></td><td><code>UTF_8.decode_without_bom_handling_and_without_replacement(<var>src</var>)</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#encode">encode</a></td><td><code>let e = <var>encoding</var>.new_encoder();<br>let res = e.encode_to_<var>*</var>(<var>src</var>, <var>dst</var>, false);<br>// &hellip;</br>let last_res = e.encode_to_<var>*</var>(<var>src</var>, <var>dst</var>, true);</code></td><td><code><var>encoding</var>.encode(<var>src</var>)</code></td></tr>
+//! <tr><td><a href="https://encoding.spec.whatwg.org/#utf-8-encode">UTF-8 encode</a></td><td>Use the UTF-8 nature of Rust strings directly:<br><code><var>write</var>(<var>src</var>.as_bytes());<br>// refill src<br><var>write</var>(<var>src</var>.as_bytes());<br>// refill src<br><var>write</var>(<var>src</var>.as_bytes());<br>// &hellip;</code></td><td>Use the UTF-8 nature of Rust strings directly:<br><code><var>src</var>.as_bytes()</code></td></tr>
+//! </tbody>
+//! </table>
+//!
+//! # Compatibility with the rust-encoding API
+//!
+//! The crate
+//! [encoding_rs_compat](https://github.com/hsivonen/encoding_rs_compat/)
+//! is a drop-in replacement for rust-encoding 0.2.32 that implements (most of)
+//! the API of rust-encoding 0.2.32 on top of encoding_rs.
+//!
+//! # Mapping rust-encoding concepts to encoding_rs concepts
+//!
+//! The following table provides a mapping from rust-encoding constructs to
+//! encoding_rs ones.
+//!
+//! <table>
+//! <thead>
+//! <tr><th>rust-encoding</th><th>encoding_rs</th></tr>
+//! </thead>
+//! <tbody>
+//! <tr><td><code>encoding::EncodingRef</code></td><td><code>&amp;'static encoding_rs::Encoding</code></td></tr>
+//! <tr><td><code>encoding::all::<var>WINDOWS_31J</var></code> (not based on the WHATWG name for some encodings)</td><td><code>encoding_rs::<var>SHIFT_JIS</var></code> (always the WHATWG name uppercased and hyphens replaced with underscores)</td></tr>
+//! <tr><td><code>encoding::all::ERROR</code></td><td>Not available because not in the Encoding Standard</td></tr>
+//! <tr><td><code>encoding::all::ASCII</code></td><td>Not available because not in the Encoding Standard</td></tr>
+//! <tr><td><code>encoding::all::ISO_8859_1</code></td><td>Not available because not in the Encoding Standard</td></tr>
+//! <tr><td><code>encoding::all::HZ</code></td><td>Not available because not in the Encoding Standard</td></tr>
+//! <tr><td><code>encoding::label::encoding_from_whatwg_label(<var>string</var>)</code></td><td><code>encoding_rs::Encoding::for_label(<var>string</var>)</code></td></tr>
+//! <tr><td><code><var>enc</var>.whatwg_name()</code> (always lower case)</td><td><code><var>enc</var>.name()</code> (potentially mixed case)</td></tr>
+//! <tr><td><code><var>enc</var>.name()</code></td><td>Not available because not in the Encoding Standard</td></tr>
+//! <tr><td><code>encoding::decode(<var>bytes</var>, encoding::DecoderTrap::Replace, <var>enc</var>)</code></td><td><code><var>enc</var>.decode(<var>bytes</var>)</code></td></tr>
+//! <tr><td><code><var>enc</var>.decode(<var>bytes</var>, encoding::DecoderTrap::Replace)</code></td><td><code><var>enc</var>.decode_without_bom_handling(<var>bytes</var>)</code></td></tr>
+//! <tr><td><code><var>enc</var>.encode(<var>string</var>, encoding::EncoderTrap::NcrEscape)</code></td><td><code><var>enc</var>.encode(<var>string</var>)</code></td></tr>
+//! <tr><td><code><var>enc</var>.raw_decoder()</code></td><td><code><var>enc</var>.new_decoder_without_bom_handling()</code></td></tr>
+//! <tr><td><code><var>enc</var>.raw_encoder()</code></td><td><code><var>enc</var>.new_encoder()</code></td></tr>
+//! <tr><td><code>encoding::RawDecoder</code></td><td><code>encoding_rs::Decoder</code></td></tr>
+//! <tr><td><code>encoding::RawEncoder</code></td><td><code>encoding_rs::Encoder</code></td></tr>
+//! <tr><td><code><var>raw_decoder</var>.raw_feed(<var>src</var>, <var>dst_string</var>)</code></td><td><code><var>dst_string</var>.reserve(<var>decoder</var>.max_utf8_buffer_length_without_replacement(<var>src</var>.len()));<br><var>decoder</var>.decode_to_string_without_replacement(<var>src</var>, <var>dst_string</var>, false)</code></td></tr>
+//! <tr><td><code><var>raw_encoder</var>.raw_feed(<var>src</var>, <var>dst_vec</var>)</code></td><td><code><var>dst_vec</var>.reserve(<var>encoder</var>.max_buffer_length_from_utf8_without_replacement(<var>src</var>.len()));<br><var>encoder</var>.encode_from_utf8_to_vec_without_replacement(<var>src</var>, <var>dst_vec</var>, false)</code></td></tr>
+//! <tr><td><code><var>raw_decoder</var>.raw_finish(<var>dst</var>)</code></td><td><code><var>dst_string</var>.reserve(<var>decoder</var>.max_utf8_buffer_length_without_replacement(0));<br><var>decoder</var>.decode_to_string_without_replacement(b"", <var>dst</var>, true)</code></td></tr>
+//! <tr><td><code><var>raw_encoder</var>.raw_finish(<var>dst</var>)</code></td><td><code><var>dst_vec</var>.reserve(<var>encoder</var>.max_buffer_length_from_utf8_without_replacement(0));<br><var>encoder</var>.encode_from_utf8_to_vec_without_replacement("", <var>dst</var>, true)</code></td></tr>
+//! <tr><td><code>encoding::DecoderTrap::Strict</code></td><td><code>decode*</code> methods that have <code>_without_replacement</code> in their name (and treating the `Malformed` result as fatal).</td></tr>
+//! <tr><td><code>encoding::DecoderTrap::Replace</code></td><td><code>decode*</code> methods that <i>do not</i> have <code>_without_replacement</code> in their name.</td></tr>
+//! <tr><td><code>encoding::DecoderTrap::Ignore</code></td><td>It is a bad idea to ignore errors due to security issues, but this could be implemented using <code>decode*</code> methods that have <code>_without_replacement</code> in their name.</td></tr>
+//! <tr><td><code>encoding::DecoderTrap::Call(DecoderTrapFunc)</code></td><td>Can be implemented using <code>decode*</code> methods that have <code>_without_replacement</code> in their name.</td></tr>
+//! <tr><td><code>encoding::EncoderTrap::Strict</code></td><td><code>encode*</code> methods that have <code>_without_replacement</code> in their name (and treating the `Unmappable` result as fatal).</td></tr>
+//! <tr><td><code>encoding::EncoderTrap::Replace</code></td><td>Can be implemented using <code>encode*</code> methods that have <code>_without_replacement</code> in their name.</td></tr>
+//! <tr><td><code>encoding::EncoderTrap::Ignore</code></td><td>It is a bad idea to ignore errors due to security issues, but this could be implemented using <code>encode*</code> methods that have <code>_without_replacement</code> in their name.</td></tr>
+//! <tr><td><code>encoding::EncoderTrap::NcrEscape</code></td><td><code>encode*</code> methods that <i>do not</i> have <code>_without_replacement</code> in their name.</td></tr>
+//! <tr><td><code>encoding::EncoderTrap::Call(EncoderTrapFunc)</code></td><td>Can be implemented using <code>encode*</code> methods that have <code>_without_replacement</code> in their name.</td></tr>
+//! </tbody>
+//! </table>
+//!
+//! # Relationship with Windows Code Pages
+//!
+//! Despite the Web and browser focus, the encodings defined by the Encoding
+//! Standard and implemented by this crate may be useful for decoding legacy
+//! data that uses Windows code pages. The following table names the single-byte
+//! encodings
+//! that have a closely related Windows code page, the number of the closest
+//! code page, a column indicating whether Windows maps unassigned code points
+//! to the Unicode Private Use Area instead of U+FFFD and a remark number
+//! indicating remarks in the list after the table.
+//!
+//! <table>
+//! <thead>
+//! <tr><th>Encoding</th><th>Code Page</th><th>PUA</th><th>Remarks</th></tr>
+//! </thead>
+//! <tbody>
+//! <tr><td>Shift_JIS</td><td>932</td><td></td><td></td></tr>
+//! <tr><td>GBK</td><td>936</td><td></td><td></td></tr>
+//! <tr><td>EUC-KR</td><td>949</td><td></td><td></td></tr>
+//! <tr><td>Big5</td><td>950</td><td></td><td></td></tr>
+//! <tr><td>IBM866</td><td>866</td><td></td><td></td></tr>
+//! <tr><td>windows-874</td><td>874</td><td>&bullet;</td><td></td></tr>
+//! <tr><td>UTF-16LE</td><td>1200</td><td></td><td></td></tr>
+//! <tr><td>UTF-16BE</td><td>1201</td><td></td><td></td></tr>
+//! <tr><td>windows-1250</td><td>1250</td><td></td><td></td></tr>
+//! <tr><td>windows-1251</td><td>1251</td><td></td><td></td></tr>
+//! <tr><td>windows-1252</td><td>1252</td><td></td><td></td></tr>
+//! <tr><td>windows-1253</td><td>1253</td><td>&bullet;</td><td></td></tr>
+//! <tr><td>windows-1254</td><td>1254</td><td></td><td></td></tr>
+//! <tr><td>windows-1255</td><td>1255</td><td>&bullet;</td><td></td></tr>
+//! <tr><td>windows-1256</td><td>1256</td><td></td><td></td></tr>
+//! <tr><td>windows-1257</td><td>1257</td><td>&bullet;</td><td></td></tr>
+//! <tr><td>windows-1258</td><td>1258</td><td></td><td></td></tr>
+//! <tr><td>macintosh</td><td>10000</td><td></td><td>1</td></tr>
+//! <tr><td>x-mac-cyrillic</td><td>10017</td><td></td><td>2</td></tr>
+//! <tr><td>KOI8-R</td><td>20866</td><td></td><td></td></tr>
+//! <tr><td>EUC-JP</td><td>20932</td><td></td><td></td></tr>
+//! <tr><td>KOI8-U</td><td>21866</td><td></td><td></td></tr>
+//! <tr><td>ISO-8859-2</td><td>28592</td><td></td><td></td></tr>
+//! <tr><td>ISO-8859-3</td><td>28593</td><td></td><td></td></tr>
+//! <tr><td>ISO-8859-4</td><td>28594</td><td></td><td></td></tr>
+//! <tr><td>ISO-8859-5</td><td>28595</td><td></td><td></td></tr>
+//! <tr><td>ISO-8859-6</td><td>28596</td><td>&bullet;</td><td></td></tr>
+//! <tr><td>ISO-8859-7</td><td>28597</td><td>&bullet;</td><td>3</td></tr>
+//! <tr><td>ISO-8859-8</td><td>28598</td><td>&bullet;</td><td>4</td></tr>
+//! <tr><td>ISO-8859-13</td><td>28603</td><td>&bullet;</td><td></td></tr>
+//! <tr><td>ISO-8859-15</td><td>28605</td><td></td><td></td></tr>
+//! <tr><td>ISO-8859-8-I</td><td>38598</td><td></td><td>5</td></tr>
+//! <tr><td>ISO-2022-JP</td><td>50220</td><td></td><td></td></tr>
+//! <tr><td>gb18030</td><td>54936</td><td></td><td></td></tr>
+//! <tr><td>UTF-8</td><td>65001</td><td></td><td></td></tr>
+//! </tbody>
+//! </table>
+//!
+//! 1. Windows decodes 0xBD to U+2126 OHM SIGN instead of U+03A9 GREEK CAPITAL LETTER OMEGA.
+//! 2. Windows decodes 0xFF to U+00A4 CURRENCY SIGN instead of U+20AC EURO SIGN.
+//! 3. Windows decodes the currency signs at 0xA4 and 0xA5 as well as 0xAA,
+//! which should be U+037A GREEK YPOGEGRAMMENI, to PUA code points. Windows
+//! decodes 0xA1 to U+02BD MODIFIER LETTER REVERSED COMMA instead of U+2018
+//! LEFT SINGLE QUOTATION MARK and 0xA2 to U+02BC MODIFIER LETTER APOSTROPHE
+//! instead of U+2019 RIGHT SINGLE QUOTATION MARK.
+//! 4. Windows decodes 0xAF to OVERLINE instead of MACRON and 0xFE and 0xFD to PUA instead
+//! of LRM and RLM.
+//! 5. Remarks from the previous item apply.
+//!
+//! The differences between this crate and Windows in the case of multibyte encodings
+//! are not yet fully documented here. The lack of remarks above should not be taken
+//! as indication of lack of differences.
+//!
+//! # Notable Differences from IANA Naming
+//!
+//! In some cases, the Encoding Standard specifies the popular unextended encoding
+//! name where in IANA terms one of the other labels would be more precise considering
+//! the extensions that the Encoding Standard has unified into the encoding.
+//!
+//! <table>
+//! <thead>
+//! <tr><th>Encoding</th><th>IANA</th></tr>
+//! </thead>
+//! <tbody>
+//! <tr><td>Big5</td><td>Big5-HKSCS</td></tr>
+//! <tr><td>EUC-KR</td><td>windows-949</td></tr>
+//! <tr><td>Shift_JIS</td><td>windows-31j</td></tr>
+//! <tr><td>x-mac-cyrillic</td><td>x-mac-ukrainian</td></tr>
+//! </tbody>
+//! </table>
+//!
+//! In other cases where the Encoding Standard unifies unextended and extended
+//! variants of an encoding, the encoding gets the name of the extended
+//! variant.
+//!
+//! <table>
+//! <thead>
+//! <tr><th>IANA</th><th>Unified into Encoding</th></tr>
+//! </thead>
+//! <tbody>
+//! <tr><td>ISO-8859-1</td><td>windows-1252</td></tr>
+//! <tr><td>ISO-8859-9</td><td>windows-1254</td></tr>
+//! <tr><td>TIS-620</td><td>windows-874</td></tr>
+//! </tbody>
+//! </table>
+//!
+//! See the section [_UTF-16LE, UTF-16BE and Unicode Encoding Schemes_](#utf-16le-utf-16be-and-unicode-encoding-schemes)
+//! for discussion about the UTF-16 family.
+
+#![no_std]
+#![cfg_attr(feature = "simd-accel", feature(core_intrinsics))]
+
+#[cfg(feature = "alloc")]
+#[cfg_attr(test, macro_use)]
+extern crate alloc;
+
+extern crate core;
+#[macro_use]
+extern crate cfg_if;
+
+#[cfg(all(
+ feature = "simd-accel",
+ any(
+ target_feature = "sse2",
+ all(target_endian = "little", target_arch = "aarch64"),
+ all(target_endian = "little", target_feature = "neon")
+ )
+))]
+#[macro_use(shuffle)]
+extern crate packed_simd;
+
+#[cfg(feature = "serde")]
+extern crate serde;
+
+#[cfg(all(test, feature = "serde"))]
+extern crate bincode;
+#[cfg(all(test, feature = "serde"))]
+#[macro_use]
+extern crate serde_derive;
+#[cfg(all(test, feature = "serde"))]
+extern crate serde_json;
+
+#[macro_use]
+mod macros;
+
+#[cfg(all(
+ feature = "simd-accel",
+ any(
+ target_feature = "sse2",
+ all(target_endian = "little", target_arch = "aarch64"),
+ all(target_endian = "little", target_feature = "neon")
+ )
+))]
+mod simd_funcs;
+
+#[cfg(all(test, feature = "alloc"))]
+mod testing;
+
+mod big5;
+mod euc_jp;
+mod euc_kr;
+mod gb18030;
+mod iso_2022_jp;
+mod replacement;
+mod shift_jis;
+mod single_byte;
+mod utf_16;
+mod utf_8;
+mod x_user_defined;
+
+mod ascii;
+mod data;
+mod handles;
+mod variant;
+
+pub mod mem;
+
+use crate::ascii::ascii_valid_up_to;
+use crate::ascii::iso_2022_jp_ascii_valid_up_to;
+use crate::utf_8::utf8_valid_up_to;
+use crate::variant::*;
+
+#[cfg(feature = "alloc")]
+use alloc::borrow::Cow;
+#[cfg(feature = "alloc")]
+use alloc::string::String;
+#[cfg(feature = "alloc")]
+use alloc::vec::Vec;
+use core::cmp::Ordering;
+use core::hash::Hash;
+use core::hash::Hasher;
+
+#[cfg(feature = "serde")]
+use serde::de::Visitor;
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+
+/// This has to be the max length of an NCR instead of max
+/// minus one, because we can't rely on getting the minus
+/// one from the space reserved for the current unmappable,
+/// because the ISO-2022-JP encoder can fill up that space
+/// with a state transition escape.
+const NCR_EXTRA: usize = 10; // &#1114111;
+
+// BEGIN GENERATED CODE. PLEASE DO NOT EDIT.
+// Instead, please regenerate using generate-encoding-data.py
+
+const LONGEST_LABEL_LENGTH: usize = 19; // cseucpkdfmtjapanese
+
+/// The initializer for the [Big5](static.BIG5.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static BIG5_INIT: Encoding = Encoding {
+ name: "Big5",
+ variant: VariantEncoding::Big5,
+};
+
+/// The Big5 encoding.
+///
+/// This is Big5 with HKSCS with mappings to more recent Unicode assignments
+/// instead of the Private Use Area code points that have been used historically.
+/// It is believed to be able to decode existing Web content in a way that makes
+/// sense.
+///
+/// To avoid form submissions generating data that Web servers don't understand,
+/// the encoder doesn't use the HKSCS byte sequences that precede the unextended
+/// Big5 in the lexical order.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/big5.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/big5-bmp.html)
+///
+/// This encoding is designed to be suited for decoding the Windows code page 950
+/// and its HKSCS patched "951" variant such that the text makes sense, given
+/// assignments that Unicode has made after those encodings used Private Use
+/// Area characters.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static BIG5: &'static Encoding = &BIG5_INIT;
+
+/// The initializer for the [EUC-JP](static.EUC_JP.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static EUC_JP_INIT: Encoding = Encoding {
+ name: "EUC-JP",
+ variant: VariantEncoding::EucJp,
+};
+
+/// The EUC-JP encoding.
+///
+/// This is the legacy Unix encoding for Japanese.
+///
+/// For compatibility with Web servers that don't expect three-byte sequences
+/// in form submissions, the encoder doesn't generate three-byte sequences.
+/// That is, the JIS X 0212 support is decode-only.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/euc-jp.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/euc-jp-bmp.html)
+///
+/// This encoding roughly matches the Windows code page 20932. There are error
+/// handling differences and a handful of 2-byte sequences that decode differently.
+/// Additionall, Windows doesn't support 3-byte sequences.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static EUC_JP: &'static Encoding = &EUC_JP_INIT;
+
+/// The initializer for the [EUC-KR](static.EUC_KR.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static EUC_KR_INIT: Encoding = Encoding {
+ name: "EUC-KR",
+ variant: VariantEncoding::EucKr,
+};
+
+/// The EUC-KR encoding.
+///
+/// This is the Korean encoding for Windows. It extends the Unix legacy encoding
+/// for Korean, based on KS X 1001 (which also formed the base of MacKorean on Mac OS
+/// Classic), with all the characters from the Hangul Syllables block of Unicode.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/euc-kr.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/euc-kr-bmp.html)
+///
+/// This encoding matches the Windows code page 949, except Windows decodes byte 0x80
+/// to U+0080 and some byte sequences that are error per the Encoding Standard to
+/// the question mark or the Private Use Area.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static EUC_KR: &'static Encoding = &EUC_KR_INIT;
+
+/// The initializer for the [GBK](static.GBK.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static GBK_INIT: Encoding = Encoding {
+ name: "GBK",
+ variant: VariantEncoding::Gbk,
+};
+
+/// The GBK encoding.
+///
+/// The decoder for this encoding is the same as the decoder for gb18030.
+/// The encoder side of this encoding is GBK with Windows code page 936 euro
+/// sign behavior. GBK extends GB2312-80 to cover the CJK Unified Ideographs
+/// Unicode block as well as a handful of ideographs from the CJK Unified
+/// Ideographs Extension A and CJK Compatibility Ideographs blocks.
+///
+/// Unlike e.g. in the case of ISO-8859-1 and windows-1252, GBK encoder wasn't
+/// unified with the gb18030 encoder in the Encoding Standard out of concern
+/// that servers that expect GBK form submissions might not be able to handle
+/// the four-byte sequences.
+///
+/// [Index visualization for the two-byte sequences](https://encoding.spec.whatwg.org/gb18030.html),
+/// [Visualization of BMP coverage of the two-byte index](https://encoding.spec.whatwg.org/gb18030-bmp.html)
+///
+/// The encoder of this encoding roughly matches the Windows code page 936.
+/// The decoder side is a superset.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static GBK: &'static Encoding = &GBK_INIT;
+
+/// The initializer for the [IBM866](static.IBM866.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static IBM866_INIT: Encoding = Encoding {
+ name: "IBM866",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.ibm866, 0x0440, 96, 16),
+};
+
+/// The IBM866 encoding.
+///
+/// This the most notable one of the DOS Cyrillic code pages. It has the same
+/// box drawing characters as code page 437, so it can be used for decoding
+/// DOS-era ASCII + box drawing data.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/ibm866.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/ibm866-bmp.html)
+///
+/// This encoding matches the Windows code page 866.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static IBM866: &'static Encoding = &IBM866_INIT;
+
+/// The initializer for the [ISO-2022-JP](static.ISO_2022_JP.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_2022_JP_INIT: Encoding = Encoding {
+ name: "ISO-2022-JP",
+ variant: VariantEncoding::Iso2022Jp,
+};
+
+/// The ISO-2022-JP encoding.
+///
+/// This the primary pre-UTF-8 encoding for Japanese email. It uses the ASCII
+/// byte range to encode non-Basic Latin characters. It's the only encoding
+/// supported by this crate whose encoder is stateful.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/jis0208.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/jis0208-bmp.html)
+///
+/// This encoding roughly matches the Windows code page 50220. Notably, Windows
+/// uses U+30FB in place of the REPLACEMENT CHARACTER and otherwise differs in
+/// error handling.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_2022_JP: &'static Encoding = &ISO_2022_JP_INIT;
+
+/// The initializer for the [ISO-8859-10](static.ISO_8859_10.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_10_INIT: Encoding = Encoding {
+ name: "ISO-8859-10",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_10, 0x00DA, 90, 6),
+};
+
+/// The ISO-8859-10 encoding.
+///
+/// This is the Nordic part of the ISO/IEC 8859 encoding family. This encoding
+/// is also known as Latin 6.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-10.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-10-bmp.html)
+///
+/// The Windows code page number for this encoding is 28600, but kernel32.dll
+/// does not support this encoding.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_10: &'static Encoding = &ISO_8859_10_INIT;
+
+/// The initializer for the [ISO-8859-13](static.ISO_8859_13.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_13_INIT: Encoding = Encoding {
+ name: "ISO-8859-13",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_13, 0x00DF, 95, 1),
+};
+
+/// The ISO-8859-13 encoding.
+///
+/// This is the Baltic part of the ISO/IEC 8859 encoding family. This encoding
+/// is also known as Latin 7.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-13.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-13-bmp.html)
+///
+/// This encoding matches the Windows code page 28603, except Windows decodes
+/// unassigned code points to the Private Use Area of Unicode.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_13: &'static Encoding = &ISO_8859_13_INIT;
+
+/// The initializer for the [ISO-8859-14](static.ISO_8859_14.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_14_INIT: Encoding = Encoding {
+ name: "ISO-8859-14",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_14, 0x00DF, 95, 17),
+};
+
+/// The ISO-8859-14 encoding.
+///
+/// This is the Celtic part of the ISO/IEC 8859 encoding family. This encoding
+/// is also known as Latin 8.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-14.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-14-bmp.html)
+///
+/// The Windows code page number for this encoding is 28604, but kernel32.dll
+/// does not support this encoding.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_14: &'static Encoding = &ISO_8859_14_INIT;
+
+/// The initializer for the [ISO-8859-15](static.ISO_8859_15.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_15_INIT: Encoding = Encoding {
+ name: "ISO-8859-15",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_15, 0x00BF, 63, 65),
+};
+
+/// The ISO-8859-15 encoding.
+///
+/// This is the revised Western European part of the ISO/IEC 8859 encoding
+/// family. This encoding is also known as Latin 9.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-15.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-15-bmp.html)
+///
+/// This encoding matches the Windows code page 28605.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_15: &'static Encoding = &ISO_8859_15_INIT;
+
+/// The initializer for the [ISO-8859-16](static.ISO_8859_16.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_16_INIT: Encoding = Encoding {
+ name: "ISO-8859-16",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_16, 0x00DF, 95, 4),
+};
+
+/// The ISO-8859-16 encoding.
+///
+/// This is the South-Eastern European part of the ISO/IEC 8859 encoding
+/// family. This encoding is also known as Latin 10.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-16.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-16-bmp.html)
+///
+/// The Windows code page number for this encoding is 28606, but kernel32.dll
+/// does not support this encoding.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_16: &'static Encoding = &ISO_8859_16_INIT;
+
+/// The initializer for the [ISO-8859-2](static.ISO_8859_2.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_2_INIT: Encoding = Encoding {
+ name: "ISO-8859-2",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_2, 0x00DF, 95, 1),
+};
+
+/// The ISO-8859-2 encoding.
+///
+/// This is the Central European part of the ISO/IEC 8859 encoding family. This encoding is also known as Latin 2.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-2.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-2-bmp.html)
+///
+/// This encoding matches the Windows code page 28592.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_2: &'static Encoding = &ISO_8859_2_INIT;
+
+/// The initializer for the [ISO-8859-3](static.ISO_8859_3.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_3_INIT: Encoding = Encoding {
+ name: "ISO-8859-3",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_3, 0x00DF, 95, 4),
+};
+
+/// The ISO-8859-3 encoding.
+///
+/// This is the South European part of the ISO/IEC 8859 encoding family. This encoding is also known as Latin 3.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-3.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-3-bmp.html)
+///
+/// This encoding matches the Windows code page 28593.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_3: &'static Encoding = &ISO_8859_3_INIT;
+
+/// The initializer for the [ISO-8859-4](static.ISO_8859_4.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_4_INIT: Encoding = Encoding {
+ name: "ISO-8859-4",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_4, 0x00DF, 95, 1),
+};
+
+/// The ISO-8859-4 encoding.
+///
+/// This is the North European part of the ISO/IEC 8859 encoding family. This encoding is also known as Latin 4.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-4.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-4-bmp.html)
+///
+/// This encoding matches the Windows code page 28594.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_4: &'static Encoding = &ISO_8859_4_INIT;
+
+/// The initializer for the [ISO-8859-5](static.ISO_8859_5.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_5_INIT: Encoding = Encoding {
+ name: "ISO-8859-5",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_5, 0x040E, 46, 66),
+};
+
+/// The ISO-8859-5 encoding.
+///
+/// This is the Cyrillic part of the ISO/IEC 8859 encoding family.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-5.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-5-bmp.html)
+///
+/// This encoding matches the Windows code page 28595.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_5: &'static Encoding = &ISO_8859_5_INIT;
+
+/// The initializer for the [ISO-8859-6](static.ISO_8859_6.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_6_INIT: Encoding = Encoding {
+ name: "ISO-8859-6",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_6, 0x0621, 65, 26),
+};
+
+/// The ISO-8859-6 encoding.
+///
+/// This is the Arabic part of the ISO/IEC 8859 encoding family.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-6.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-6-bmp.html)
+///
+/// This encoding matches the Windows code page 28596, except Windows decodes
+/// unassigned code points to the Private Use Area of Unicode.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_6: &'static Encoding = &ISO_8859_6_INIT;
+
+/// The initializer for the [ISO-8859-7](static.ISO_8859_7.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_7_INIT: Encoding = Encoding {
+ name: "ISO-8859-7",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_7, 0x03A3, 83, 44),
+};
+
+/// The ISO-8859-7 encoding.
+///
+/// This is the Greek part of the ISO/IEC 8859 encoding family.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-7.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-7-bmp.html)
+///
+/// This encoding roughly matches the Windows code page 28597. Windows decodes
+/// unassigned code points, the currency signs at 0xA4 and 0xA5 as well as
+/// 0xAA, which should be U+037A GREEK YPOGEGRAMMENI, to the Private Use Area
+/// of Unicode. Windows decodes 0xA1 to U+02BD MODIFIER LETTER REVERSED COMMA
+/// instead of U+2018 LEFT SINGLE QUOTATION MARK and 0xA2 to U+02BC MODIFIER
+/// LETTER APOSTROPHE instead of U+2019 RIGHT SINGLE QUOTATION MARK.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_7: &'static Encoding = &ISO_8859_7_INIT;
+
+/// The initializer for the [ISO-8859-8](static.ISO_8859_8.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_8_INIT: Encoding = Encoding {
+ name: "ISO-8859-8",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_8, 0x05D0, 96, 27),
+};
+
+/// The ISO-8859-8 encoding.
+///
+/// This is the Hebrew part of the ISO/IEC 8859 encoding family in visual order.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-8.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-8-bmp.html)
+///
+/// This encoding roughly matches the Windows code page 28598. Windows decodes
+/// 0xAF to OVERLINE instead of MACRON and 0xFE and 0xFD to the Private Use
+/// Area instead of LRM and RLM. Windows decodes unassigned code points to
+/// the private use area.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_8: &'static Encoding = &ISO_8859_8_INIT;
+
+/// The initializer for the [ISO-8859-8-I](static.ISO_8859_8_I.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static ISO_8859_8_I_INIT: Encoding = Encoding {
+ name: "ISO-8859-8-I",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.iso_8859_8, 0x05D0, 96, 27),
+};
+
+/// The ISO-8859-8-I encoding.
+///
+/// This is the Hebrew part of the ISO/IEC 8859 encoding family in logical order.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/iso-8859-8.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/iso-8859-8-bmp.html)
+///
+/// This encoding roughly matches the Windows code page 38598. Windows decodes
+/// 0xAF to OVERLINE instead of MACRON and 0xFE and 0xFD to the Private Use
+/// Area instead of LRM and RLM. Windows decodes unassigned code points to
+/// the private use area.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static ISO_8859_8_I: &'static Encoding = &ISO_8859_8_I_INIT;
+
+/// The initializer for the [KOI8-R](static.KOI8_R.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static KOI8_R_INIT: Encoding = Encoding {
+ name: "KOI8-R",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.koi8_r, 0x044E, 64, 1),
+};
+
+/// The KOI8-R encoding.
+///
+/// This is an encoding for Russian from [RFC 1489](https://tools.ietf.org/html/rfc1489).
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/koi8-r.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/koi8-r-bmp.html)
+///
+/// This encoding matches the Windows code page 20866.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static KOI8_R: &'static Encoding = &KOI8_R_INIT;
+
+/// The initializer for the [KOI8-U](static.KOI8_U.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static KOI8_U_INIT: Encoding = Encoding {
+ name: "KOI8-U",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.koi8_u, 0x044E, 64, 1),
+};
+
+/// The KOI8-U encoding.
+///
+/// This is an encoding for Ukrainian adapted from KOI8-R.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/koi8-u.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/koi8-u-bmp.html)
+///
+/// This encoding matches the Windows code page 21866.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static KOI8_U: &'static Encoding = &KOI8_U_INIT;
+
+/// The initializer for the [Shift_JIS](static.SHIFT_JIS.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static SHIFT_JIS_INIT: Encoding = Encoding {
+ name: "Shift_JIS",
+ variant: VariantEncoding::ShiftJis,
+};
+
+/// The Shift_JIS encoding.
+///
+/// This is the Japanese encoding for Windows.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/shift_jis.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/shift_jis-bmp.html)
+///
+/// This encoding matches the Windows code page 932, except Windows decodes some byte
+/// sequences that are error per the Encoding Standard to the question mark or the
+/// Private Use Area and generally uses U+30FB in place of the REPLACEMENT CHARACTER.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static SHIFT_JIS: &'static Encoding = &SHIFT_JIS_INIT;
+
+/// The initializer for the [UTF-16BE](static.UTF_16BE.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static UTF_16BE_INIT: Encoding = Encoding {
+ name: "UTF-16BE",
+ variant: VariantEncoding::Utf16Be,
+};
+
+/// The UTF-16BE encoding.
+///
+/// This decode-only encoding uses 16-bit code units due to Unicode originally
+/// having been designed as a 16-bit reportoire. In the absence of a byte order
+/// mark the big endian byte order is assumed.
+///
+/// There is no corresponding encoder in this crate or in the Encoding
+/// Standard. The output encoding of this encoding is UTF-8.
+///
+/// This encoding matches the Windows code page 1201.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static UTF_16BE: &'static Encoding = &UTF_16BE_INIT;
+
+/// The initializer for the [UTF-16LE](static.UTF_16LE.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static UTF_16LE_INIT: Encoding = Encoding {
+ name: "UTF-16LE",
+ variant: VariantEncoding::Utf16Le,
+};
+
+/// The UTF-16LE encoding.
+///
+/// This decode-only encoding uses 16-bit code units due to Unicode originally
+/// having been designed as a 16-bit reportoire. In the absence of a byte order
+/// mark the little endian byte order is assumed.
+///
+/// There is no corresponding encoder in this crate or in the Encoding
+/// Standard. The output encoding of this encoding is UTF-8.
+///
+/// This encoding matches the Windows code page 1200.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static UTF_16LE: &'static Encoding = &UTF_16LE_INIT;
+
+/// The initializer for the [UTF-8](static.UTF_8.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static UTF_8_INIT: Encoding = Encoding {
+ name: "UTF-8",
+ variant: VariantEncoding::Utf8,
+};
+
+/// The UTF-8 encoding.
+///
+/// This is the encoding that should be used for all new development it can
+/// represent all of Unicode.
+///
+/// This encoding matches the Windows code page 65001, except Windows differs
+/// in the number of errors generated for some erroneous byte sequences.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static UTF_8: &'static Encoding = &UTF_8_INIT;
+
+/// The initializer for the [gb18030](static.GB18030.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static GB18030_INIT: Encoding = Encoding {
+ name: "gb18030",
+ variant: VariantEncoding::Gb18030,
+};
+
+/// The gb18030 encoding.
+///
+/// This encoding matches GB18030-2005 except the two-byte sequence 0xA3 0xA0
+/// maps to U+3000 for compatibility with existing Web content. As a result,
+/// this encoding can represent all of Unicode except for the private-use
+/// character U+E5E5.
+///
+/// [Index visualization for the two-byte sequences](https://encoding.spec.whatwg.org/gb18030.html),
+/// [Visualization of BMP coverage of the two-byte index](https://encoding.spec.whatwg.org/gb18030-bmp.html)
+///
+/// This encoding matches the Windows code page 54936.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static GB18030: &'static Encoding = &GB18030_INIT;
+
+/// The initializer for the [macintosh](static.MACINTOSH.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static MACINTOSH_INIT: Encoding = Encoding {
+ name: "macintosh",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.macintosh, 0x00CD, 106, 3),
+};
+
+/// The macintosh encoding.
+///
+/// This is the MacRoman encoding from Mac OS Classic.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/macintosh.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/macintosh-bmp.html)
+///
+/// This encoding matches the Windows code page 10000, except Windows decodes
+/// 0xBD to U+2126 OHM SIGN instead of U+03A9 GREEK CAPITAL LETTER OMEGA.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static MACINTOSH: &'static Encoding = &MACINTOSH_INIT;
+
+/// The initializer for the [replacement](static.REPLACEMENT.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static REPLACEMENT_INIT: Encoding = Encoding {
+ name: "replacement",
+ variant: VariantEncoding::Replacement,
+};
+
+/// The replacement encoding.
+///
+/// This decode-only encoding decodes all non-zero-length streams to a single
+/// REPLACEMENT CHARACTER. Its purpose is to avoid the use of an
+/// ASCII-compatible fallback encoding (typically windows-1252) for some
+/// encodings that are no longer supported by the Web Platform and that
+/// would be dangerous to treat as ASCII-compatible.
+///
+/// There is no corresponding encoder. The output encoding of this encoding
+/// is UTF-8.
+///
+/// This encoding does not have a Windows code page number.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static REPLACEMENT: &'static Encoding = &REPLACEMENT_INIT;
+
+/// The initializer for the [windows-1250](static.WINDOWS_1250.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1250_INIT: Encoding = Encoding {
+ name: "windows-1250",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1250, 0x00DC, 92, 2),
+};
+
+/// The windows-1250 encoding.
+///
+/// This is the Central European encoding for Windows.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1250.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1250-bmp.html)
+///
+/// This encoding matches the Windows code page 1250.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1250: &'static Encoding = &WINDOWS_1250_INIT;
+
+/// The initializer for the [windows-1251](static.WINDOWS_1251.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1251_INIT: Encoding = Encoding {
+ name: "windows-1251",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1251, 0x0410, 64, 64),
+};
+
+/// The windows-1251 encoding.
+///
+/// This is the Cyrillic encoding for Windows.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1251.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1251-bmp.html)
+///
+/// This encoding matches the Windows code page 1251.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1251: &'static Encoding = &WINDOWS_1251_INIT;
+
+/// The initializer for the [windows-1252](static.WINDOWS_1252.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1252_INIT: Encoding = Encoding {
+ name: "windows-1252",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1252, 0x00A0, 32, 96),
+};
+
+/// The windows-1252 encoding.
+///
+/// This is the Western encoding for Windows. It is an extension of ISO-8859-1,
+/// which is known as Latin 1.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1252.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1252-bmp.html)
+///
+/// This encoding matches the Windows code page 1252.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1252: &'static Encoding = &WINDOWS_1252_INIT;
+
+/// The initializer for the [windows-1253](static.WINDOWS_1253.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1253_INIT: Encoding = Encoding {
+ name: "windows-1253",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1253, 0x03A3, 83, 44),
+};
+
+/// The windows-1253 encoding.
+///
+/// This is the Greek encoding for Windows. It is mostly an extension of
+/// ISO-8859-7, but U+0386 is mapped to a different byte.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1253.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1253-bmp.html)
+///
+/// This encoding matches the Windows code page 1253, except Windows decodes
+/// unassigned code points to the Private Use Area of Unicode.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1253: &'static Encoding = &WINDOWS_1253_INIT;
+
+/// The initializer for the [windows-1254](static.WINDOWS_1254.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1254_INIT: Encoding = Encoding {
+ name: "windows-1254",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1254, 0x00DF, 95, 17),
+};
+
+/// The windows-1254 encoding.
+///
+/// This is the Turkish encoding for Windows. It is an extension of ISO-8859-9,
+/// which is known as Latin 5.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1254.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1254-bmp.html)
+///
+/// This encoding matches the Windows code page 1254.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1254: &'static Encoding = &WINDOWS_1254_INIT;
+
+/// The initializer for the [windows-1255](static.WINDOWS_1255.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1255_INIT: Encoding = Encoding {
+ name: "windows-1255",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1255, 0x05D0, 96, 27),
+};
+
+/// The windows-1255 encoding.
+///
+/// This is the Hebrew encoding for Windows. It is an extension of ISO-8859-8-I,
+/// except for a currency sign swap.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1255.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1255-bmp.html)
+///
+/// This encoding matches the Windows code page 1255, except Windows decodes
+/// unassigned code points to the Private Use Area of Unicode.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1255: &'static Encoding = &WINDOWS_1255_INIT;
+
+/// The initializer for the [windows-1256](static.WINDOWS_1256.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1256_INIT: Encoding = Encoding {
+ name: "windows-1256",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1256, 0x0621, 65, 22),
+};
+
+/// The windows-1256 encoding.
+///
+/// This is the Arabic encoding for Windows.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1256.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1256-bmp.html)
+///
+/// This encoding matches the Windows code page 1256.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1256: &'static Encoding = &WINDOWS_1256_INIT;
+
+/// The initializer for the [windows-1257](static.WINDOWS_1257.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1257_INIT: Encoding = Encoding {
+ name: "windows-1257",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1257, 0x00DF, 95, 1),
+};
+
+/// The windows-1257 encoding.
+///
+/// This is the Baltic encoding for Windows.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1257.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1257-bmp.html)
+///
+/// This encoding matches the Windows code page 1257, except Windows decodes
+/// unassigned code points to the Private Use Area of Unicode.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1257: &'static Encoding = &WINDOWS_1257_INIT;
+
+/// The initializer for the [windows-1258](static.WINDOWS_1258.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_1258_INIT: Encoding = Encoding {
+ name: "windows-1258",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_1258, 0x00DF, 95, 4),
+};
+
+/// The windows-1258 encoding.
+///
+/// This is the Vietnamese encoding for Windows.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-1258.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-1258-bmp.html)
+///
+/// This encoding matches the Windows code page 1258 when used in the
+/// non-normalizing mode. Unlike with the other single-byte encodings, the
+/// result of decoding is not necessarily in Normalization Form C. On the
+/// other hand, input in the Normalization Form C is not encoded without
+/// replacement. In general, it's a bad idea to encode to encodings other
+/// than UTF-8, but this encoding is especially hazardous to encode to.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_1258: &'static Encoding = &WINDOWS_1258_INIT;
+
+/// The initializer for the [windows-874](static.WINDOWS_874.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static WINDOWS_874_INIT: Encoding = Encoding {
+ name: "windows-874",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.windows_874, 0x0E01, 33, 58),
+};
+
+/// The windows-874 encoding.
+///
+/// This is the Thai encoding for Windows. It is an extension of TIS-620 / ISO-8859-11.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/windows-874.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/windows-874-bmp.html)
+///
+/// This encoding matches the Windows code page 874, except Windows decodes
+/// unassigned code points to the Private Use Area of Unicode.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static WINDOWS_874: &'static Encoding = &WINDOWS_874_INIT;
+
+/// The initializer for the [x-mac-cyrillic](static.X_MAC_CYRILLIC.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static X_MAC_CYRILLIC_INIT: Encoding = Encoding {
+ name: "x-mac-cyrillic",
+ variant: VariantEncoding::SingleByte(&data::SINGLE_BYTE_DATA.x_mac_cyrillic, 0x0430, 96, 31),
+};
+
+/// The x-mac-cyrillic encoding.
+///
+/// This is the MacUkrainian encoding from Mac OS Classic.
+///
+/// [Index visualization](https://encoding.spec.whatwg.org/x-mac-cyrillic.html),
+/// [Visualization of BMP coverage](https://encoding.spec.whatwg.org/x-mac-cyrillic-bmp.html)
+///
+/// This encoding matches the Windows code page 10017.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static X_MAC_CYRILLIC: &'static Encoding = &X_MAC_CYRILLIC_INIT;
+
+/// The initializer for the [x-user-defined](static.X_USER_DEFINED.html) encoding.
+///
+/// For use only for taking the address of this form when
+/// Rust prohibits the use of the non-`_INIT` form directly,
+/// such as in initializers of other `static`s. If in doubt,
+/// use the corresponding non-`_INIT` reference-typed `static`.
+///
+/// This part of the public API will go away if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate or if Rust starts allowing static arrays
+/// to be initialized with `pub static FOO: &'static Encoding`
+/// items.
+pub static X_USER_DEFINED_INIT: Encoding = Encoding {
+ name: "x-user-defined",
+ variant: VariantEncoding::UserDefined,
+};
+
+/// The x-user-defined encoding.
+///
+/// This encoding offsets the non-ASCII bytes by `0xF700` thereby decoding
+/// them to the Private Use Area of Unicode. It was used for loading binary
+/// data into a JavaScript string using `XMLHttpRequest` before XHR supported
+/// the `"arraybuffer"` response type.
+///
+/// This encoding does not have a Windows code page number.
+///
+/// This will change from `static` to `const` if Rust changes
+/// to make the referent of `pub const FOO: &'static Encoding`
+/// unique cross-crate, so don't take the address of this
+/// `static`.
+pub static X_USER_DEFINED: &'static Encoding = &X_USER_DEFINED_INIT;
+
+static LABELS_SORTED: [&'static str; 228] = [
+ "l1",
+ "l2",
+ "l3",
+ "l4",
+ "l5",
+ "l6",
+ "l9",
+ "866",
+ "mac",
+ "koi",
+ "gbk",
+ "big5",
+ "utf8",
+ "koi8",
+ "sjis",
+ "ucs-2",
+ "ms932",
+ "cp866",
+ "utf-8",
+ "cp819",
+ "ascii",
+ "x-gbk",
+ "greek",
+ "cp1250",
+ "cp1251",
+ "latin1",
+ "gb2312",
+ "cp1252",
+ "latin2",
+ "cp1253",
+ "latin3",
+ "cp1254",
+ "latin4",
+ "cp1255",
+ "csbig5",
+ "latin5",
+ "utf-16",
+ "cp1256",
+ "ibm866",
+ "latin6",
+ "cp1257",
+ "cp1258",
+ "greek8",
+ "ibm819",
+ "arabic",
+ "visual",
+ "korean",
+ "euc-jp",
+ "koi8-r",
+ "koi8_r",
+ "euc-kr",
+ "x-sjis",
+ "koi8-u",
+ "hebrew",
+ "tis-620",
+ "gb18030",
+ "ksc5601",
+ "gb_2312",
+ "dos-874",
+ "cn-big5",
+ "unicode",
+ "chinese",
+ "logical",
+ "cskoi8r",
+ "cseuckr",
+ "koi8-ru",
+ "x-cp1250",
+ "ksc_5601",
+ "x-cp1251",
+ "iso88591",
+ "csgb2312",
+ "x-cp1252",
+ "iso88592",
+ "x-cp1253",
+ "iso88593",
+ "ecma-114",
+ "x-cp1254",
+ "iso88594",
+ "x-cp1255",
+ "iso88595",
+ "x-x-big5",
+ "x-cp1256",
+ "csibm866",
+ "iso88596",
+ "x-cp1257",
+ "iso88597",
+ "asmo-708",
+ "ecma-118",
+ "elot_928",
+ "x-cp1258",
+ "iso88598",
+ "iso88599",
+ "cyrillic",
+ "utf-16be",
+ "utf-16le",
+ "us-ascii",
+ "ms_kanji",
+ "x-euc-jp",
+ "iso885910",
+ "iso8859-1",
+ "iso885911",
+ "iso8859-2",
+ "iso8859-3",
+ "iso885913",
+ "iso8859-4",
+ "iso885914",
+ "iso8859-5",
+ "iso885915",
+ "iso8859-6",
+ "iso8859-7",
+ "iso8859-8",
+ "iso-ir-58",
+ "iso8859-9",
+ "csunicode",
+ "macintosh",
+ "shift-jis",
+ "shift_jis",
+ "iso-ir-100",
+ "iso8859-10",
+ "iso-ir-110",
+ "gb_2312-80",
+ "iso-8859-1",
+ "iso_8859-1",
+ "iso-ir-101",
+ "iso8859-11",
+ "iso-8859-2",
+ "iso_8859-2",
+ "hz-gb-2312",
+ "iso-8859-3",
+ "iso_8859-3",
+ "iso8859-13",
+ "iso-8859-4",
+ "iso_8859-4",
+ "iso8859-14",
+ "iso-ir-144",
+ "iso-8859-5",
+ "iso_8859-5",
+ "iso8859-15",
+ "iso-8859-6",
+ "iso_8859-6",
+ "iso-ir-126",
+ "iso-8859-7",
+ "iso_8859-7",
+ "iso-ir-127",
+ "iso-ir-157",
+ "iso-8859-8",
+ "iso_8859-8",
+ "iso-ir-138",
+ "iso-ir-148",
+ "iso-8859-9",
+ "iso_8859-9",
+ "iso-ir-109",
+ "iso-ir-149",
+ "big5-hkscs",
+ "csshiftjis",
+ "iso-8859-10",
+ "iso-8859-11",
+ "csisolatin1",
+ "csisolatin2",
+ "iso-8859-13",
+ "csisolatin3",
+ "iso-8859-14",
+ "windows-874",
+ "csisolatin4",
+ "iso-8859-15",
+ "iso_8859-15",
+ "csisolatin5",
+ "iso-8859-16",
+ "csisolatin6",
+ "windows-949",
+ "csisolatin9",
+ "csiso88596e",
+ "csiso88598e",
+ "unicodefffe",
+ "unicodefeff",
+ "csmacintosh",
+ "csiso88596i",
+ "csiso88598i",
+ "windows-31j",
+ "x-mac-roman",
+ "iso-2022-cn",
+ "iso-2022-jp",
+ "csiso2022jp",
+ "iso-2022-kr",
+ "csiso2022kr",
+ "replacement",
+ "windows-1250",
+ "windows-1251",
+ "windows-1252",
+ "windows-1253",
+ "windows-1254",
+ "windows-1255",
+ "windows-1256",
+ "windows-1257",
+ "windows-1258",
+ "iso-8859-6-e",
+ "iso-8859-8-e",
+ "iso-8859-6-i",
+ "iso-8859-8-i",
+ "sun_eu_greek",
+ "csksc56011987",
+ "unicode20utf8",
+ "unicode11utf8",
+ "ks_c_5601-1987",
+ "ansi_x3.4-1968",
+ "ks_c_5601-1989",
+ "x-mac-cyrillic",
+ "x-user-defined",
+ "csiso58gb231280",
+ "iso-10646-ucs-2",
+ "iso_8859-1:1987",
+ "iso_8859-2:1987",
+ "iso_8859-6:1987",
+ "iso_8859-7:1987",
+ "iso_8859-3:1988",
+ "iso_8859-4:1988",
+ "iso_8859-5:1988",
+ "iso_8859-8:1988",
+ "x-unicode20utf8",
+ "iso_8859-9:1989",
+ "csisolatingreek",
+ "x-mac-ukrainian",
+ "iso-2022-cn-ext",
+ "csisolatinarabic",
+ "csisolatinhebrew",
+ "unicode-1-1-utf-8",
+ "csisolatincyrillic",
+ "cseucpkdfmtjapanese",
+];
+
+static ENCODINGS_IN_LABEL_SORT: [&'static Encoding; 228] = [
+ &WINDOWS_1252_INIT,
+ &ISO_8859_2_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_4_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_10_INIT,
+ &ISO_8859_15_INIT,
+ &IBM866_INIT,
+ &MACINTOSH_INIT,
+ &KOI8_R_INIT,
+ &GBK_INIT,
+ &BIG5_INIT,
+ &UTF_8_INIT,
+ &KOI8_R_INIT,
+ &SHIFT_JIS_INIT,
+ &UTF_16LE_INIT,
+ &SHIFT_JIS_INIT,
+ &IBM866_INIT,
+ &UTF_8_INIT,
+ &WINDOWS_1252_INIT,
+ &WINDOWS_1252_INIT,
+ &GBK_INIT,
+ &ISO_8859_7_INIT,
+ &WINDOWS_1250_INIT,
+ &WINDOWS_1251_INIT,
+ &WINDOWS_1252_INIT,
+ &GBK_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_2_INIT,
+ &WINDOWS_1253_INIT,
+ &ISO_8859_3_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_4_INIT,
+ &WINDOWS_1255_INIT,
+ &BIG5_INIT,
+ &WINDOWS_1254_INIT,
+ &UTF_16LE_INIT,
+ &WINDOWS_1256_INIT,
+ &IBM866_INIT,
+ &ISO_8859_10_INIT,
+ &WINDOWS_1257_INIT,
+ &WINDOWS_1258_INIT,
+ &ISO_8859_7_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_8_INIT,
+ &EUC_KR_INIT,
+ &EUC_JP_INIT,
+ &KOI8_R_INIT,
+ &KOI8_R_INIT,
+ &EUC_KR_INIT,
+ &SHIFT_JIS_INIT,
+ &KOI8_U_INIT,
+ &ISO_8859_8_INIT,
+ &WINDOWS_874_INIT,
+ &GB18030_INIT,
+ &EUC_KR_INIT,
+ &GBK_INIT,
+ &WINDOWS_874_INIT,
+ &BIG5_INIT,
+ &UTF_16LE_INIT,
+ &GBK_INIT,
+ &ISO_8859_8_I_INIT,
+ &KOI8_R_INIT,
+ &EUC_KR_INIT,
+ &KOI8_U_INIT,
+ &WINDOWS_1250_INIT,
+ &EUC_KR_INIT,
+ &WINDOWS_1251_INIT,
+ &WINDOWS_1252_INIT,
+ &GBK_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_2_INIT,
+ &WINDOWS_1253_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_6_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_4_INIT,
+ &WINDOWS_1255_INIT,
+ &ISO_8859_5_INIT,
+ &BIG5_INIT,
+ &WINDOWS_1256_INIT,
+ &IBM866_INIT,
+ &ISO_8859_6_INIT,
+ &WINDOWS_1257_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_7_INIT,
+ &WINDOWS_1258_INIT,
+ &ISO_8859_8_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_5_INIT,
+ &UTF_16BE_INIT,
+ &UTF_16LE_INIT,
+ &WINDOWS_1252_INIT,
+ &SHIFT_JIS_INIT,
+ &EUC_JP_INIT,
+ &ISO_8859_10_INIT,
+ &WINDOWS_1252_INIT,
+ &WINDOWS_874_INIT,
+ &ISO_8859_2_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_13_INIT,
+ &ISO_8859_4_INIT,
+ &ISO_8859_14_INIT,
+ &ISO_8859_5_INIT,
+ &ISO_8859_15_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_8_INIT,
+ &GBK_INIT,
+ &WINDOWS_1254_INIT,
+ &UTF_16LE_INIT,
+ &MACINTOSH_INIT,
+ &SHIFT_JIS_INIT,
+ &SHIFT_JIS_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_10_INIT,
+ &ISO_8859_4_INIT,
+ &GBK_INIT,
+ &WINDOWS_1252_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_2_INIT,
+ &WINDOWS_874_INIT,
+ &ISO_8859_2_INIT,
+ &ISO_8859_2_INIT,
+ &REPLACEMENT_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_13_INIT,
+ &ISO_8859_4_INIT,
+ &ISO_8859_4_INIT,
+ &ISO_8859_14_INIT,
+ &ISO_8859_5_INIT,
+ &ISO_8859_5_INIT,
+ &ISO_8859_5_INIT,
+ &ISO_8859_15_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_10_INIT,
+ &ISO_8859_8_INIT,
+ &ISO_8859_8_INIT,
+ &ISO_8859_8_INIT,
+ &WINDOWS_1254_INIT,
+ &WINDOWS_1254_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_3_INIT,
+ &EUC_KR_INIT,
+ &BIG5_INIT,
+ &SHIFT_JIS_INIT,
+ &ISO_8859_10_INIT,
+ &WINDOWS_874_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_2_INIT,
+ &ISO_8859_13_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_14_INIT,
+ &WINDOWS_874_INIT,
+ &ISO_8859_4_INIT,
+ &ISO_8859_15_INIT,
+ &ISO_8859_15_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_16_INIT,
+ &ISO_8859_10_INIT,
+ &EUC_KR_INIT,
+ &ISO_8859_15_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_8_INIT,
+ &UTF_16BE_INIT,
+ &UTF_16LE_INIT,
+ &MACINTOSH_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_8_I_INIT,
+ &SHIFT_JIS_INIT,
+ &MACINTOSH_INIT,
+ &REPLACEMENT_INIT,
+ &ISO_2022_JP_INIT,
+ &ISO_2022_JP_INIT,
+ &REPLACEMENT_INIT,
+ &REPLACEMENT_INIT,
+ &REPLACEMENT_INIT,
+ &WINDOWS_1250_INIT,
+ &WINDOWS_1251_INIT,
+ &WINDOWS_1252_INIT,
+ &WINDOWS_1253_INIT,
+ &WINDOWS_1254_INIT,
+ &WINDOWS_1255_INIT,
+ &WINDOWS_1256_INIT,
+ &WINDOWS_1257_INIT,
+ &WINDOWS_1258_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_8_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_8_I_INIT,
+ &ISO_8859_7_INIT,
+ &EUC_KR_INIT,
+ &UTF_8_INIT,
+ &UTF_8_INIT,
+ &EUC_KR_INIT,
+ &WINDOWS_1252_INIT,
+ &EUC_KR_INIT,
+ &X_MAC_CYRILLIC_INIT,
+ &X_USER_DEFINED_INIT,
+ &GBK_INIT,
+ &UTF_16LE_INIT,
+ &WINDOWS_1252_INIT,
+ &ISO_8859_2_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_7_INIT,
+ &ISO_8859_3_INIT,
+ &ISO_8859_4_INIT,
+ &ISO_8859_5_INIT,
+ &ISO_8859_8_INIT,
+ &UTF_8_INIT,
+ &WINDOWS_1254_INIT,
+ &ISO_8859_7_INIT,
+ &X_MAC_CYRILLIC_INIT,
+ &REPLACEMENT_INIT,
+ &ISO_8859_6_INIT,
+ &ISO_8859_8_INIT,
+ &UTF_8_INIT,
+ &ISO_8859_5_INIT,
+ &EUC_JP_INIT,
+];
+
+// END GENERATED CODE
+
+/// An encoding as defined in the [Encoding Standard][1].
+///
+/// An _encoding_ defines a mapping from a `u8` sequence to a `char` sequence
+/// and, in most cases, vice versa. Each encoding has a name, an output
+/// encoding, and one or more labels.
+///
+/// _Labels_ are ASCII-case-insensitive strings that are used to identify an
+/// encoding in formats and protocols. The _name_ of the encoding is the
+/// preferred label in the case appropriate for returning from the
+/// [`characterSet`][2] property of the `Document` DOM interface.
+///
+/// The _output encoding_ is the encoding used for form submission and URL
+/// parsing on Web pages in the encoding. This is UTF-8 for the replacement,
+/// UTF-16LE and UTF-16BE encodings and the encoding itself for other
+/// encodings.
+///
+/// [1]: https://encoding.spec.whatwg.org/
+/// [2]: https://dom.spec.whatwg.org/#dom-document-characterset
+///
+/// # Streaming vs. Non-Streaming
+///
+/// When you have the entire input in a single buffer, you can use the
+/// methods [`decode()`][3], [`decode_with_bom_removal()`][3],
+/// [`decode_without_bom_handling()`][5],
+/// [`decode_without_bom_handling_and_without_replacement()`][6] and
+/// [`encode()`][7]. (These methods are available to Rust callers only and are
+/// not available in the C API.) Unlike the rest of the API available to Rust,
+/// these methods perform heap allocations. You should the `Decoder` and
+/// `Encoder` objects when your input is split into multiple buffers or when
+/// you want to control the allocation of the output buffers.
+///
+/// [3]: #method.decode
+/// [4]: #method.decode_with_bom_removal
+/// [5]: #method.decode_without_bom_handling
+/// [6]: #method.decode_without_bom_handling_and_without_replacement
+/// [7]: #method.encode
+///
+/// # Instances
+///
+/// All instances of `Encoding` are statically allocated and have the `'static`
+/// lifetime. There is precisely one unique `Encoding` instance for each
+/// encoding defined in the Encoding Standard.
+///
+/// To obtain a reference to a particular encoding whose identity you know at
+/// compile time, use a `static` that refers to encoding. There is a `static`
+/// for each encoding. The `static`s are named in all caps with hyphens
+/// replaced with underscores (and in C/C++ have `_ENCODING` appended to the
+/// name). For example, if you know at compile time that you will want to
+/// decode using the UTF-8 encoding, use the `UTF_8` `static` (`UTF_8_ENCODING`
+/// in C/C++).
+///
+/// Additionally, there are non-reference-typed forms ending with `_INIT` to
+/// work around the problem that `static`s of the type `&'static Encoding`
+/// cannot be used to initialize items of an array whose type is
+/// `[&'static Encoding; N]`.
+///
+/// If you don't know what encoding you need at compile time and need to
+/// dynamically get an encoding by label, use
+/// <code>Encoding::<a href="#method.for_label">for_label</a>(<var>label</var>)</code>.
+///
+/// Instances of `Encoding` can be compared with `==` (in both Rust and in
+/// C/C++).
+pub struct Encoding {
+ name: &'static str,
+ variant: VariantEncoding,
+}
+
+impl Encoding {
+ /// Implements the
+ /// [_get an encoding_](https://encoding.spec.whatwg.org/#concept-encoding-get)
+ /// algorithm.
+ ///
+ /// If, after ASCII-lowercasing and removing leading and trailing
+ /// whitespace, the argument matches a label defined in the Encoding
+ /// Standard, `Some(&'static Encoding)` representing the corresponding
+ /// encoding is returned. If there is no match, `None` is returned.
+ ///
+ /// This is the right method to use if the action upon the method returning
+ /// `None` is to use a fallback encoding (e.g. `WINDOWS_1252`) instead.
+ /// When the action upon the method returning `None` is not to proceed with
+ /// a fallback but to refuse processing, `for_label_no_replacement()` is more
+ /// appropriate.
+ ///
+ /// The argument is of type `&[u8]` instead of `&str` to save callers
+ /// that are extracting the label from a non-UTF-8 protocol the trouble
+ /// of conversion to UTF-8. (If you have a `&str`, just call `.as_bytes()`
+ /// on it.)
+ ///
+ /// Available via the C wrapper.
+ ///
+ /// # Example
+ /// ```
+ /// use encoding_rs::Encoding;
+ ///
+ /// assert_eq!(Some(encoding_rs::UTF_8), Encoding::for_label(b"utf-8"));
+ /// assert_eq!(Some(encoding_rs::UTF_8), Encoding::for_label(b"unicode11utf8"));
+ ///
+ /// assert_eq!(Some(encoding_rs::ISO_8859_2), Encoding::for_label(b"latin2"));
+ ///
+ /// assert_eq!(Some(encoding_rs::UTF_16BE), Encoding::for_label(b"utf-16be"));
+ ///
+ /// assert_eq!(None, Encoding::for_label(b"unrecognized label"));
+ /// ```
+ pub fn for_label(label: &[u8]) -> Option<&'static Encoding> {
+ let mut trimmed = [0u8; LONGEST_LABEL_LENGTH];
+ let mut trimmed_pos = 0usize;
+ let mut iter = label.into_iter();
+ // before
+ loop {
+ match iter.next() {
+ None => {
+ return None;
+ }
+ Some(byte) => {
+ // The characters used in labels are:
+ // a-z (except q, but excluding it below seems excessive)
+ // 0-9
+ // . _ - :
+ match *byte {
+ 0x09u8 | 0x0Au8 | 0x0Cu8 | 0x0Du8 | 0x20u8 => {
+ continue;
+ }
+ b'A'..=b'Z' => {
+ trimmed[trimmed_pos] = *byte + 0x20u8;
+ trimmed_pos = 1usize;
+ break;
+ }
+ b'a'..=b'z' | b'0'..=b'9' | b'-' | b'_' | b':' | b'.' => {
+ trimmed[trimmed_pos] = *byte;
+ trimmed_pos = 1usize;
+ break;
+ }
+ _ => {
+ return None;
+ }
+ }
+ }
+ }
+ }
+ // inside
+ loop {
+ match iter.next() {
+ None => {
+ break;
+ }
+ Some(byte) => {
+ match *byte {
+ 0x09u8 | 0x0Au8 | 0x0Cu8 | 0x0Du8 | 0x20u8 => {
+ break;
+ }
+ b'A'..=b'Z' => {
+ if trimmed_pos == LONGEST_LABEL_LENGTH {
+ // There's no encoding with a label this long
+ return None;
+ }
+ trimmed[trimmed_pos] = *byte + 0x20u8;
+ trimmed_pos += 1usize;
+ continue;
+ }
+ b'a'..=b'z' | b'0'..=b'9' | b'-' | b'_' | b':' | b'.' => {
+ if trimmed_pos == LONGEST_LABEL_LENGTH {
+ // There's no encoding with a label this long
+ return None;
+ }
+ trimmed[trimmed_pos] = *byte;
+ trimmed_pos += 1usize;
+ continue;
+ }
+ _ => {
+ return None;
+ }
+ }
+ }
+ }
+ }
+ // after
+ loop {
+ match iter.next() {
+ None => {
+ break;
+ }
+ Some(byte) => {
+ match *byte {
+ 0x09u8 | 0x0Au8 | 0x0Cu8 | 0x0Du8 | 0x20u8 => {
+ continue;
+ }
+ _ => {
+ // There's no label with space in the middle
+ return None;
+ }
+ }
+ }
+ }
+ }
+ let candidate = &trimmed[..trimmed_pos];
+ match LABELS_SORTED.binary_search_by(|probe| {
+ let bytes = probe.as_bytes();
+ let c = bytes.len().cmp(&candidate.len());
+ if c != Ordering::Equal {
+ return c;
+ }
+ let probe_iter = bytes.iter().rev();
+ let candidate_iter = candidate.iter().rev();
+ probe_iter.cmp(candidate_iter)
+ }) {
+ Ok(i) => Some(ENCODINGS_IN_LABEL_SORT[i]),
+ Err(_) => None,
+ }
+ }
+
+ /// This method behaves the same as `for_label()`, except when `for_label()`
+ /// would return `Some(REPLACEMENT)`, this method returns `None` instead.
+ ///
+ /// This method is useful in scenarios where a fatal error is required
+ /// upon invalid label, because in those cases the caller typically wishes
+ /// to treat the labels that map to the replacement encoding as fatal
+ /// errors, too.
+ ///
+ /// It is not OK to use this method when the action upon the method returning
+ /// `None` is to use a fallback encoding (e.g. `WINDOWS_1252`). In such a
+ /// case, the `for_label()` method should be used instead in order to avoid
+ /// unsafe fallback for labels that `for_label()` maps to `Some(REPLACEMENT)`.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn for_label_no_replacement(label: &[u8]) -> Option<&'static Encoding> {
+ match Encoding::for_label(label) {
+ None => None,
+ Some(encoding) => {
+ if encoding == REPLACEMENT {
+ None
+ } else {
+ Some(encoding)
+ }
+ }
+ }
+ }
+
+ /// Performs non-incremental BOM sniffing.
+ ///
+ /// The argument must either be a buffer representing the entire input
+ /// stream (non-streaming case) or a buffer representing at least the first
+ /// three bytes of the input stream (streaming case).
+ ///
+ /// Returns `Some((UTF_8, 3))`, `Some((UTF_16LE, 2))` or
+ /// `Some((UTF_16BE, 2))` if the argument starts with the UTF-8, UTF-16LE
+ /// or UTF-16BE BOM or `None` otherwise.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn for_bom(buffer: &[u8]) -> Option<(&'static Encoding, usize)> {
+ if buffer.starts_with(b"\xEF\xBB\xBF") {
+ Some((UTF_8, 3))
+ } else if buffer.starts_with(b"\xFF\xFE") {
+ Some((UTF_16LE, 2))
+ } else if buffer.starts_with(b"\xFE\xFF") {
+ Some((UTF_16BE, 2))
+ } else {
+ None
+ }
+ }
+
+ /// Returns the name of this encoding.
+ ///
+ /// This name is appropriate to return as-is from the DOM
+ /// `document.characterSet` property.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn name(&'static self) -> &'static str {
+ self.name
+ }
+
+ /// Checks whether the _output encoding_ of this encoding can encode every
+ /// `char`. (Only true if the output encoding is UTF-8.)
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn can_encode_everything(&'static self) -> bool {
+ self.output_encoding() == UTF_8
+ }
+
+ /// Checks whether the bytes 0x00...0x7F map exclusively to the characters
+ /// U+0000...U+007F and vice versa.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn is_ascii_compatible(&'static self) -> bool {
+ !(self == REPLACEMENT || self == UTF_16BE || self == UTF_16LE || self == ISO_2022_JP)
+ }
+
+ /// Checks whether this encoding maps one byte to one Basic Multilingual
+ /// Plane code point (i.e. byte length equals decoded UTF-16 length) and
+ /// vice versa (for mappable characters).
+ ///
+ /// `true` iff this encoding is on the list of [Legacy single-byte
+ /// encodings](https://encoding.spec.whatwg.org/#legacy-single-byte-encodings)
+ /// in the spec or x-user-defined.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn is_single_byte(&'static self) -> bool {
+ self.variant.is_single_byte()
+ }
+
+ /// Checks whether the bytes 0x00...0x7F map mostly to the characters
+ /// U+0000...U+007F and vice versa.
+ #[cfg(feature = "alloc")]
+ #[inline]
+ fn is_potentially_borrowable(&'static self) -> bool {
+ !(self == REPLACEMENT || self == UTF_16BE || self == UTF_16LE)
+ }
+
+ /// Returns the _output encoding_ of this encoding. This is UTF-8 for
+ /// UTF-16BE, UTF-16LE, and replacement and the encoding itself otherwise.
+ ///
+ /// _Note:_ The _output encoding_ concept is needed for form submission and
+ /// error handling in the query strings of URLs in the Web Platform.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn output_encoding(&'static self) -> &'static Encoding {
+ if self == REPLACEMENT || self == UTF_16BE || self == UTF_16LE {
+ UTF_8
+ } else {
+ self
+ }
+ }
+
+ /// Decode complete input to `Cow<'a, str>` _with BOM sniffing_ and with
+ /// malformed sequences replaced with the REPLACEMENT CHARACTER when the
+ /// entire input is available as a single buffer (i.e. the end of the
+ /// buffer marks the end of the stream).
+ ///
+ /// The BOM, if any, does not appear in the output.
+ ///
+ /// This method implements the (non-streaming version of) the
+ /// [_decode_](https://encoding.spec.whatwg.org/#decode) spec concept.
+ ///
+ /// The second item in the returned tuple is the encoding that was actually
+ /// used (which may differ from this encoding thanks to BOM sniffing).
+ ///
+ /// The third item in the returned tuple indicates whether there were
+ /// malformed sequences (that were replaced with the REPLACEMENT CHARACTER).
+ ///
+ /// _Note:_ It is wrong to use this when the input buffer represents only
+ /// a segment of the input instead of the whole input. Use `new_decoder()`
+ /// when decoding segmented input.
+ ///
+ /// This method performs a one or two heap allocations for the backing
+ /// buffer of the `String` when unable to borrow. (One allocation if not
+ /// errors and potentially another one in the presence of errors.) The
+ /// first allocation assumes jemalloc and may not be optimal with
+ /// allocators that do not use power-of-two buckets. A borrow is performed
+ /// if decoding UTF-8 and the input is valid UTF-8, if decoding an
+ /// ASCII-compatible encoding and the input is ASCII-only, or when decoding
+ /// ISO-2022-JP and the input is entirely in the ASCII state without state
+ /// transitions.
+ ///
+ /// # Panics
+ ///
+ /// If the size calculation for a heap-allocated backing buffer overflows
+ /// `usize`.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ #[inline]
+ pub fn decode<'a>(&'static self, bytes: &'a [u8]) -> (Cow<'a, str>, &'static Encoding, bool) {
+ let (encoding, without_bom) = match Encoding::for_bom(bytes) {
+ Some((encoding, bom_length)) => (encoding, &bytes[bom_length..]),
+ None => (self, bytes),
+ };
+ let (cow, had_errors) = encoding.decode_without_bom_handling(without_bom);
+ (cow, encoding, had_errors)
+ }
+
+ /// Decode complete input to `Cow<'a, str>` _with BOM removal_ and with
+ /// malformed sequences replaced with the REPLACEMENT CHARACTER when the
+ /// entire input is available as a single buffer (i.e. the end of the
+ /// buffer marks the end of the stream).
+ ///
+ /// Only an initial byte sequence that is a BOM for this encoding is removed.
+ ///
+ /// When invoked on `UTF_8`, this method implements the (non-streaming
+ /// version of) the
+ /// [_UTF-8 decode_](https://encoding.spec.whatwg.org/#utf-8-decode) spec
+ /// concept.
+ ///
+ /// The second item in the returned pair indicates whether there were
+ /// malformed sequences (that were replaced with the REPLACEMENT CHARACTER).
+ ///
+ /// _Note:_ It is wrong to use this when the input buffer represents only
+ /// a segment of the input instead of the whole input. Use
+ /// `new_decoder_with_bom_removal()` when decoding segmented input.
+ ///
+ /// This method performs a one or two heap allocations for the backing
+ /// buffer of the `String` when unable to borrow. (One allocation if not
+ /// errors and potentially another one in the presence of errors.) The
+ /// first allocation assumes jemalloc and may not be optimal with
+ /// allocators that do not use power-of-two buckets. A borrow is performed
+ /// if decoding UTF-8 and the input is valid UTF-8, if decoding an
+ /// ASCII-compatible encoding and the input is ASCII-only, or when decoding
+ /// ISO-2022-JP and the input is entirely in the ASCII state without state
+ /// transitions.
+ ///
+ /// # Panics
+ ///
+ /// If the size calculation for a heap-allocated backing buffer overflows
+ /// `usize`.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ #[inline]
+ pub fn decode_with_bom_removal<'a>(&'static self, bytes: &'a [u8]) -> (Cow<'a, str>, bool) {
+ let without_bom = if self == UTF_8 && bytes.starts_with(b"\xEF\xBB\xBF") {
+ &bytes[3..]
+ } else if (self == UTF_16LE && bytes.starts_with(b"\xFF\xFE"))
+ || (self == UTF_16BE && bytes.starts_with(b"\xFE\xFF"))
+ {
+ &bytes[2..]
+ } else {
+ bytes
+ };
+ self.decode_without_bom_handling(without_bom)
+ }
+
+ /// Decode complete input to `Cow<'a, str>` _without BOM handling_ and
+ /// with malformed sequences replaced with the REPLACEMENT CHARACTER when
+ /// the entire input is available as a single buffer (i.e. the end of the
+ /// buffer marks the end of the stream).
+ ///
+ /// When invoked on `UTF_8`, this method implements the (non-streaming
+ /// version of) the
+ /// [_UTF-8 decode without BOM_](https://encoding.spec.whatwg.org/#utf-8-decode-without-bom)
+ /// spec concept.
+ ///
+ /// The second item in the returned pair indicates whether there were
+ /// malformed sequences (that were replaced with the REPLACEMENT CHARACTER).
+ ///
+ /// _Note:_ It is wrong to use this when the input buffer represents only
+ /// a segment of the input instead of the whole input. Use
+ /// `new_decoder_without_bom_handling()` when decoding segmented input.
+ ///
+ /// This method performs a one or two heap allocations for the backing
+ /// buffer of the `String` when unable to borrow. (One allocation if not
+ /// errors and potentially another one in the presence of errors.) The
+ /// first allocation assumes jemalloc and may not be optimal with
+ /// allocators that do not use power-of-two buckets. A borrow is performed
+ /// if decoding UTF-8 and the input is valid UTF-8, if decoding an
+ /// ASCII-compatible encoding and the input is ASCII-only, or when decoding
+ /// ISO-2022-JP and the input is entirely in the ASCII state without state
+ /// transitions.
+ ///
+ /// # Panics
+ ///
+ /// If the size calculation for a heap-allocated backing buffer overflows
+ /// `usize`.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn decode_without_bom_handling<'a>(&'static self, bytes: &'a [u8]) -> (Cow<'a, str>, bool) {
+ let (mut decoder, mut string, mut total_read) = if self.is_potentially_borrowable() {
+ let valid_up_to = if self == UTF_8 {
+ utf8_valid_up_to(bytes)
+ } else if self == ISO_2022_JP {
+ iso_2022_jp_ascii_valid_up_to(bytes)
+ } else {
+ ascii_valid_up_to(bytes)
+ };
+ if valid_up_to == bytes.len() {
+ let str: &str = unsafe { core::str::from_utf8_unchecked(bytes) };
+ return (Cow::Borrowed(str), false);
+ }
+ let decoder = self.new_decoder_without_bom_handling();
+
+ let rounded_without_replacement = checked_next_power_of_two(checked_add(
+ valid_up_to,
+ decoder.max_utf8_buffer_length_without_replacement(bytes.len() - valid_up_to),
+ ));
+ let with_replacement = checked_add(
+ valid_up_to,
+ decoder.max_utf8_buffer_length(bytes.len() - valid_up_to),
+ );
+ let mut string = String::with_capacity(
+ checked_min(rounded_without_replacement, with_replacement).unwrap(),
+ );
+ unsafe {
+ let vec = string.as_mut_vec();
+ vec.set_len(valid_up_to);
+ core::ptr::copy_nonoverlapping(bytes.as_ptr(), vec.as_mut_ptr(), valid_up_to);
+ }
+ (decoder, string, valid_up_to)
+ } else {
+ let decoder = self.new_decoder_without_bom_handling();
+ let rounded_without_replacement = checked_next_power_of_two(
+ decoder.max_utf8_buffer_length_without_replacement(bytes.len()),
+ );
+ let with_replacement = decoder.max_utf8_buffer_length(bytes.len());
+ let string = String::with_capacity(
+ checked_min(rounded_without_replacement, with_replacement).unwrap(),
+ );
+ (decoder, string, 0)
+ };
+
+ let mut total_had_errors = false;
+ loop {
+ let (result, read, had_errors) =
+ decoder.decode_to_string(&bytes[total_read..], &mut string, true);
+ total_read += read;
+ total_had_errors |= had_errors;
+ match result {
+ CoderResult::InputEmpty => {
+ debug_assert_eq!(total_read, bytes.len());
+ return (Cow::Owned(string), total_had_errors);
+ }
+ CoderResult::OutputFull => {
+ // Allocate for the worst case. That is, we should come
+ // here at most once per invocation of this method.
+ let needed = decoder.max_utf8_buffer_length(bytes.len() - total_read);
+ string.reserve(needed.unwrap());
+ }
+ }
+ }
+ }
+
+ /// Decode complete input to `Cow<'a, str>` _without BOM handling_ and
+ /// _with malformed sequences treated as fatal_ when the entire input is
+ /// available as a single buffer (i.e. the end of the buffer marks the end
+ /// of the stream).
+ ///
+ /// When invoked on `UTF_8`, this method implements the (non-streaming
+ /// version of) the
+ /// [_UTF-8 decode without BOM or fail_](https://encoding.spec.whatwg.org/#utf-8-decode-without-bom-or-fail)
+ /// spec concept.
+ ///
+ /// Returns `None` if a malformed sequence was encountered and the result
+ /// of the decode as `Some(String)` otherwise.
+ ///
+ /// _Note:_ It is wrong to use this when the input buffer represents only
+ /// a segment of the input instead of the whole input. Use
+ /// `new_decoder_without_bom_handling()` when decoding segmented input.
+ ///
+ /// This method performs a single heap allocation for the backing
+ /// buffer of the `String` when unable to borrow. A borrow is performed if
+ /// decoding UTF-8 and the input is valid UTF-8, if decoding an
+ /// ASCII-compatible encoding and the input is ASCII-only, or when decoding
+ /// ISO-2022-JP and the input is entirely in the ASCII state without state
+ /// transitions.
+ ///
+ /// # Panics
+ ///
+ /// If the size calculation for a heap-allocated backing buffer overflows
+ /// `usize`.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn decode_without_bom_handling_and_without_replacement<'a>(
+ &'static self,
+ bytes: &'a [u8],
+ ) -> Option<Cow<'a, str>> {
+ if self == UTF_8 {
+ let valid_up_to = utf8_valid_up_to(bytes);
+ if valid_up_to == bytes.len() {
+ let str: &str = unsafe { core::str::from_utf8_unchecked(bytes) };
+ return Some(Cow::Borrowed(str));
+ }
+ return None;
+ }
+ let (mut decoder, mut string, input) = if self.is_potentially_borrowable() {
+ let valid_up_to = if self == ISO_2022_JP {
+ iso_2022_jp_ascii_valid_up_to(bytes)
+ } else {
+ ascii_valid_up_to(bytes)
+ };
+ if valid_up_to == bytes.len() {
+ let str: &str = unsafe { core::str::from_utf8_unchecked(bytes) };
+ return Some(Cow::Borrowed(str));
+ }
+ let decoder = self.new_decoder_without_bom_handling();
+ let mut string = String::with_capacity(
+ checked_add(
+ valid_up_to,
+ decoder.max_utf8_buffer_length_without_replacement(bytes.len() - valid_up_to),
+ )
+ .unwrap(),
+ );
+ unsafe {
+ let vec = string.as_mut_vec();
+ vec.set_len(valid_up_to);
+ core::ptr::copy_nonoverlapping(bytes.as_ptr(), vec.as_mut_ptr(), valid_up_to);
+ }
+ (decoder, string, &bytes[valid_up_to..])
+ } else {
+ let decoder = self.new_decoder_without_bom_handling();
+ let string = String::with_capacity(
+ decoder
+ .max_utf8_buffer_length_without_replacement(bytes.len())
+ .unwrap(),
+ );
+ (decoder, string, bytes)
+ };
+ let (result, read) = decoder.decode_to_string_without_replacement(input, &mut string, true);
+ match result {
+ DecoderResult::InputEmpty => {
+ debug_assert_eq!(read, input.len());
+ Some(Cow::Owned(string))
+ }
+ DecoderResult::Malformed(_, _) => None,
+ DecoderResult::OutputFull => unreachable!(),
+ }
+ }
+
+ /// Encode complete input to `Cow<'a, [u8]>` using the
+ /// [_output encoding_](Encoding::output_encoding) of this encoding with
+ /// unmappable characters replaced with decimal numeric character references
+ /// when the entire input is available as a single buffer (i.e. the end of
+ /// the buffer marks the end of the stream).
+ ///
+ /// This method implements the (non-streaming version of) the
+ /// [_encode_](https://encoding.spec.whatwg.org/#encode) spec concept. For
+ /// the [_UTF-8 encode_](https://encoding.spec.whatwg.org/#utf-8-encode)
+ /// spec concept, it is slightly more efficient to use
+ /// <code><var>string</var>.as_bytes()</code> instead of invoking this
+ /// method on `UTF_8`.
+ ///
+ /// The second item in the returned tuple is the encoding that was actually
+ /// used (*which may differ from this encoding thanks to some encodings
+ /// having UTF-8 as their output encoding*).
+ ///
+ /// The third item in the returned tuple indicates whether there were
+ /// unmappable characters (that were replaced with HTML numeric character
+ /// references).
+ ///
+ /// _Note:_ It is wrong to use this when the input buffer represents only
+ /// a segment of the input instead of the whole input. Use `new_encoder()`
+ /// when encoding segmented output.
+ ///
+ /// When encoding to UTF-8 or when encoding an ASCII-only input to a
+ /// ASCII-compatible encoding, this method returns a borrow of the input
+ /// without a heap allocation. Otherwise, this method performs a single
+ /// heap allocation for the backing buffer of the `Vec<u8>` if there are no
+ /// unmappable characters and potentially multiple heap allocations if
+ /// there are. These allocations are tuned for jemalloc and may not be
+ /// optimal when using a different allocator that doesn't use power-of-two
+ /// buckets.
+ ///
+ /// # Panics
+ ///
+ /// If the size calculation for a heap-allocated backing buffer overflows
+ /// `usize`.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn encode<'a>(&'static self, string: &'a str) -> (Cow<'a, [u8]>, &'static Encoding, bool) {
+ let output_encoding = self.output_encoding();
+ if output_encoding == UTF_8 {
+ return (Cow::Borrowed(string.as_bytes()), output_encoding, false);
+ }
+ debug_assert!(output_encoding.is_potentially_borrowable());
+ let bytes = string.as_bytes();
+ let valid_up_to = if output_encoding == ISO_2022_JP {
+ iso_2022_jp_ascii_valid_up_to(bytes)
+ } else {
+ ascii_valid_up_to(bytes)
+ };
+ if valid_up_to == bytes.len() {
+ return (Cow::Borrowed(bytes), output_encoding, false);
+ }
+ let mut encoder = output_encoding.new_encoder();
+ let mut vec: Vec<u8> = Vec::with_capacity(
+ (checked_add(
+ valid_up_to,
+ encoder.max_buffer_length_from_utf8_if_no_unmappables(string.len() - valid_up_to),
+ ))
+ .unwrap()
+ .next_power_of_two(),
+ );
+ unsafe {
+ vec.set_len(valid_up_to);
+ core::ptr::copy_nonoverlapping(bytes.as_ptr(), vec.as_mut_ptr(), valid_up_to);
+ }
+ let mut total_read = valid_up_to;
+ let mut total_had_errors = false;
+ loop {
+ let (result, read, had_errors) =
+ encoder.encode_from_utf8_to_vec(&string[total_read..], &mut vec, true);
+ total_read += read;
+ total_had_errors |= had_errors;
+ match result {
+ CoderResult::InputEmpty => {
+ debug_assert_eq!(total_read, string.len());
+ return (Cow::Owned(vec), output_encoding, total_had_errors);
+ }
+ CoderResult::OutputFull => {
+ // reserve_exact wants to know how much more on top of current
+ // length--not current capacity.
+ let needed = encoder
+ .max_buffer_length_from_utf8_if_no_unmappables(string.len() - total_read);
+ let rounded = (checked_add(vec.capacity(), needed))
+ .unwrap()
+ .next_power_of_two();
+ let additional = rounded - vec.len();
+ vec.reserve_exact(additional);
+ }
+ }
+ }
+ }
+
+ fn new_variant_decoder(&'static self) -> VariantDecoder {
+ self.variant.new_variant_decoder()
+ }
+
+ /// Instantiates a new decoder for this encoding with BOM sniffing enabled.
+ ///
+ /// BOM sniffing may cause the returned decoder to morph into a decoder
+ /// for UTF-8, UTF-16LE or UTF-16BE instead of this encoding. The BOM
+ /// does not appear in the output.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn new_decoder(&'static self) -> Decoder {
+ Decoder::new(self, self.new_variant_decoder(), BomHandling::Sniff)
+ }
+
+ /// Instantiates a new decoder for this encoding with BOM removal.
+ ///
+ /// If the input starts with bytes that are the BOM for this encoding,
+ /// those bytes are removed. However, the decoder never morphs into a
+ /// decoder for another encoding: A BOM for another encoding is treated as
+ /// (potentially malformed) input to the decoding algorithm for this
+ /// encoding.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn new_decoder_with_bom_removal(&'static self) -> Decoder {
+ Decoder::new(self, self.new_variant_decoder(), BomHandling::Remove)
+ }
+
+ /// Instantiates a new decoder for this encoding with BOM handling disabled.
+ ///
+ /// If the input starts with bytes that look like a BOM, those bytes are
+ /// not treated as a BOM. (Hence, the decoder never morphs into a decoder
+ /// for another encoding.)
+ ///
+ /// _Note:_ If the caller has performed BOM sniffing on its own but has not
+ /// removed the BOM, the caller should use `new_decoder_with_bom_removal()`
+ /// instead of this method to cause the BOM to be removed.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn new_decoder_without_bom_handling(&'static self) -> Decoder {
+ Decoder::new(self, self.new_variant_decoder(), BomHandling::Off)
+ }
+
+ /// Instantiates a new encoder for the [_output encoding_](Encoding::output_encoding)
+ /// of this encoding.
+ ///
+ /// _Note:_ The output encoding of UTF-16BE, UTF-16LE, and replacement is UTF-8. There
+ /// is no encoder for UTF-16BE, UTF-16LE, and replacement themselves.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn new_encoder(&'static self) -> Encoder {
+ let enc = self.output_encoding();
+ enc.variant.new_encoder(enc)
+ }
+
+ /// Validates UTF-8.
+ ///
+ /// Returns the index of the first byte that makes the input malformed as
+ /// UTF-8 or the length of the slice if the slice is entirely valid.
+ ///
+ /// This is currently faster than the corresponding standard library
+ /// functionality. If this implementation gets upstreamed to the standard
+ /// library, this method may be removed in the future.
+ ///
+ /// Available via the C wrapper.
+ pub fn utf8_valid_up_to(bytes: &[u8]) -> usize {
+ utf8_valid_up_to(bytes)
+ }
+
+ /// Validates ASCII.
+ ///
+ /// Returns the index of the first byte that makes the input malformed as
+ /// ASCII or the length of the slice if the slice is entirely valid.
+ ///
+ /// Available via the C wrapper.
+ pub fn ascii_valid_up_to(bytes: &[u8]) -> usize {
+ ascii_valid_up_to(bytes)
+ }
+
+ /// Validates ISO-2022-JP ASCII-state data.
+ ///
+ /// Returns the index of the first byte that makes the input not
+ /// representable in the ASCII state of ISO-2022-JP or the length of the
+ /// slice if the slice is entirely representable in the ASCII state of
+ /// ISO-2022-JP.
+ ///
+ /// Available via the C wrapper.
+ pub fn iso_2022_jp_ascii_valid_up_to(bytes: &[u8]) -> usize {
+ iso_2022_jp_ascii_valid_up_to(bytes)
+ }
+}
+
+impl PartialEq for Encoding {
+ #[inline]
+ fn eq(&self, other: &Encoding) -> bool {
+ (self as *const Encoding) == (other as *const Encoding)
+ }
+}
+
+impl Eq for Encoding {}
+
+#[cfg(test)]
+impl PartialOrd for Encoding {
+ fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+ (self as *const Encoding as usize).partial_cmp(&(other as *const Encoding as usize))
+ }
+}
+
+#[cfg(test)]
+impl Ord for Encoding {
+ fn cmp(&self, other: &Self) -> Ordering {
+ (self as *const Encoding as usize).cmp(&(other as *const Encoding as usize))
+ }
+}
+
+impl Hash for Encoding {
+ #[inline]
+ fn hash<H: Hasher>(&self, state: &mut H) {
+ (self as *const Encoding).hash(state);
+ }
+}
+
+impl core::fmt::Debug for Encoding {
+ #[inline]
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
+ write!(f, "Encoding {{ {} }}", self.name)
+ }
+}
+
+#[cfg(feature = "serde")]
+impl Serialize for Encoding {
+ #[inline]
+ fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+ where
+ S: Serializer,
+ {
+ serializer.serialize_str(self.name)
+ }
+}
+
+#[cfg(feature = "serde")]
+struct EncodingVisitor;
+
+#[cfg(feature = "serde")]
+impl<'de> Visitor<'de> for EncodingVisitor {
+ type Value = &'static Encoding;
+
+ fn expecting(&self, formatter: &mut core::fmt::Formatter) -> core::fmt::Result {
+ formatter.write_str("a valid encoding label")
+ }
+
+ fn visit_str<E>(self, value: &str) -> Result<&'static Encoding, E>
+ where
+ E: serde::de::Error,
+ {
+ if let Some(enc) = Encoding::for_label(value.as_bytes()) {
+ Ok(enc)
+ } else {
+ Err(E::custom(alloc::format!(
+ "invalid encoding label: {}",
+ value
+ )))
+ }
+ }
+}
+
+#[cfg(feature = "serde")]
+impl<'de> Deserialize<'de> for &'static Encoding {
+ fn deserialize<D>(deserializer: D) -> Result<&'static Encoding, D::Error>
+ where
+ D: Deserializer<'de>,
+ {
+ deserializer.deserialize_str(EncodingVisitor)
+ }
+}
+
+/// Tracks the life cycle of a decoder from BOM sniffing to conversion to end.
+#[derive(PartialEq, Debug, Copy, Clone)]
+enum DecoderLifeCycle {
+ /// The decoder has seen no input yet.
+ AtStart,
+ /// The decoder has seen no input yet but expects UTF-8.
+ AtUtf8Start,
+ /// The decoder has seen no input yet but expects UTF-16BE.
+ AtUtf16BeStart,
+ /// The decoder has seen no input yet but expects UTF-16LE.
+ AtUtf16LeStart,
+ /// The decoder has seen EF.
+ SeenUtf8First,
+ /// The decoder has seen EF, BB.
+ SeenUtf8Second,
+ /// The decoder has seen FE.
+ SeenUtf16BeFirst,
+ /// The decoder has seen FF.
+ SeenUtf16LeFirst,
+ /// Saw EF, BB but not BF, there was a buffer boundary after BB and the
+ /// underlying decoder reported EF as an error, so we need to remember to
+ /// push BB before the next buffer.
+ ConvertingWithPendingBB,
+ /// No longer looking for a BOM and EOF not yet seen.
+ Converting,
+ /// EOF has been seen.
+ Finished,
+}
+
+/// Communicate the BOM handling mode.
+#[derive(Debug, Copy, Clone)]
+enum BomHandling {
+ /// Don't handle the BOM
+ Off,
+ /// Sniff for UTF-8, UTF-16BE or UTF-16LE BOM
+ Sniff,
+ /// Remove the BOM only if it's the BOM for this encoding
+ Remove,
+}
+
+/// Result of a (potentially partial) decode or encode operation with
+/// replacement.
+#[must_use]
+#[derive(Debug, PartialEq, Eq)]
+pub enum CoderResult {
+ /// The input was exhausted.
+ ///
+ /// If this result was returned from a call where `last` was `true`, the
+ /// conversion process has completed. Otherwise, the caller should call a
+ /// decode or encode method again with more input.
+ InputEmpty,
+
+ /// The converter cannot produce another unit of output, because the output
+ /// buffer does not have enough space left.
+ ///
+ /// The caller must provide more output space upon the next call and re-push
+ /// the remaining input to the converter.
+ OutputFull,
+}
+
+/// Result of a (potentially partial) decode operation without replacement.
+#[must_use]
+#[derive(Debug, PartialEq, Eq)]
+pub enum DecoderResult {
+ /// The input was exhausted.
+ ///
+ /// If this result was returned from a call where `last` was `true`, the
+ /// decoding process has completed. Otherwise, the caller should call a
+ /// decode method again with more input.
+ InputEmpty,
+
+ /// The decoder cannot produce another unit of output, because the output
+ /// buffer does not have enough space left.
+ ///
+ /// The caller must provide more output space upon the next call and re-push
+ /// the remaining input to the decoder.
+ OutputFull,
+
+ /// The decoder encountered a malformed byte sequence.
+ ///
+ /// The caller must either treat this as a fatal error or must append one
+ /// REPLACEMENT CHARACTER (U+FFFD) to the output and then re-push the
+ /// the remaining input to the decoder.
+ ///
+ /// The first wrapped integer indicates the length of the malformed byte
+ /// sequence. The second wrapped integer indicates the number of bytes
+ /// that were consumed after the malformed sequence. If the second
+ /// integer is zero, the last byte that was consumed is the last byte of
+ /// the malformed sequence. Note that the malformed bytes may have been part
+ /// of an earlier input buffer.
+ ///
+ /// The first wrapped integer can have values 1, 2, 3 or 4. The second
+ /// wrapped integer can have values 0, 1, 2 or 3. The worst-case sum
+ /// of the two is 6, which happens with ISO-2022-JP.
+ Malformed(u8, u8), // u8 instead of usize to avoid useless bloat
+}
+
+/// A converter that decodes a byte stream into Unicode according to a
+/// character encoding in a streaming (incremental) manner.
+///
+/// The various `decode_*` methods take an input buffer (`src`) and an output
+/// buffer `dst` both of which are caller-allocated. There are variants for
+/// both UTF-8 and UTF-16 output buffers.
+///
+/// A `decode_*` method decodes bytes from `src` into Unicode characters stored
+/// into `dst` until one of the following three things happens:
+///
+/// 1. A malformed byte sequence is encountered (`*_without_replacement`
+/// variants only).
+///
+/// 2. The output buffer has been filled so near capacity that the decoder
+/// cannot be sure that processing an additional byte of input wouldn't
+/// cause so much output that the output buffer would overflow.
+///
+/// 3. All the input bytes have been processed.
+///
+/// The `decode_*` method then returns tuple of a status indicating which one
+/// of the three reasons to return happened, how many input bytes were read,
+/// how many output code units (`u8` when decoding into UTF-8 and `u16`
+/// when decoding to UTF-16) were written (except when decoding into `String`,
+/// whose length change indicates this), and in the case of the
+/// variants performing replacement, a boolean indicating whether an error was
+/// replaced with the REPLACEMENT CHARACTER during the call.
+///
+/// The number of bytes "written" is what's logically written. Garbage may be
+/// written in the output buffer beyond the point logically written to.
+/// Therefore, if you wish to decode into an `&mut str`, you should use the
+/// methods that take an `&mut str` argument instead of the ones that take an
+/// `&mut [u8]` argument. The former take care of overwriting the trailing
+/// garbage to ensure the UTF-8 validity of the `&mut str` as a whole, but the
+/// latter don't.
+///
+/// In the case of the `*_without_replacement` variants, the status is a
+/// [`DecoderResult`][1] enumeration (possibilities `Malformed`, `OutputFull` and
+/// `InputEmpty` corresponding to the three cases listed above).
+///
+/// In the case of methods whose name does not end with
+/// `*_without_replacement`, malformed sequences are automatically replaced
+/// with the REPLACEMENT CHARACTER and errors do not cause the methods to
+/// return early.
+///
+/// When decoding to UTF-8, the output buffer must have at least 4 bytes of
+/// space. When decoding to UTF-16, the output buffer must have at least two
+/// UTF-16 code units (`u16`) of space.
+///
+/// When decoding to 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
+/// [`max_utf8_buffer_length_without_replacement()`][2]. When decoding to UTF-8
+/// with replacement, the length of the output buffer that guarantees the
+/// methods not to return indicating that more output space is needed is given
+/// by [`max_utf8_buffer_length()`][3]. When decoding to UTF-16 with
+/// or without replacement, the length of the output buffer that guarantees
+/// the methods not to return indicating that more output space is needed is
+/// given by [`max_utf16_buffer_length()`][4].
+///
+/// The output written into `dst` is guaranteed to be valid UTF-8 or UTF-16,
+/// and the output after each `decode_*` call is guaranteed to consist of
+/// complete characters. (I.e. the code unit sequence for the last character is
+/// guaranteed not to be split across output buffers.)
+///
+/// The boolean argument `last` indicates that the end of the stream is reached
+/// when all the bytes in `src` have been consumed.
+///
+/// A `Decoder` object can be used to incrementally decode a byte stream.
+///
+/// During the processing of a single stream, the caller must call `decode_*`
+/// zero or more times with `last` set to `false` and then call `decode_*` at
+/// least once with `last` set to `true`. If `decode_*` returns `InputEmpty`,
+/// the processing of the stream has ended. Otherwise, the caller must call
+/// `decode_*` again with `last` set to `true` (or treat a `Malformed` result as
+/// a fatal error).
+///
+/// Once the stream has ended, the `Decoder` object must not be used anymore.
+/// That is, you need to create another one to process another stream.
+///
+/// When the decoder returns `OutputFull` or the decoder returns `Malformed` and
+/// the caller does not wish to treat it as a fatal error, the input buffer
+/// `src` may not have been completely consumed. In that case, the caller must
+/// pass the unconsumed contents of `src` to `decode_*` again upon the next
+/// call.
+///
+/// [1]: enum.DecoderResult.html
+/// [2]: #method.max_utf8_buffer_length_without_replacement
+/// [3]: #method.max_utf8_buffer_length
+/// [4]: #method.max_utf16_buffer_length
+///
+/// # Infinite loops
+///
+/// When converting with a fixed-size output buffer whose size is too small to
+/// accommodate one character or (when applicable) one numeric character
+/// reference 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).
+pub struct Decoder {
+ encoding: &'static Encoding,
+ variant: VariantDecoder,
+ life_cycle: DecoderLifeCycle,
+}
+
+impl Decoder {
+ fn new(enc: &'static Encoding, decoder: VariantDecoder, sniffing: BomHandling) -> Decoder {
+ Decoder {
+ encoding: enc,
+ variant: decoder,
+ life_cycle: match sniffing {
+ BomHandling::Off => DecoderLifeCycle::Converting,
+ BomHandling::Sniff => DecoderLifeCycle::AtStart,
+ BomHandling::Remove => {
+ if enc == UTF_8 {
+ DecoderLifeCycle::AtUtf8Start
+ } else if enc == UTF_16BE {
+ DecoderLifeCycle::AtUtf16BeStart
+ } else if enc == UTF_16LE {
+ DecoderLifeCycle::AtUtf16LeStart
+ } else {
+ DecoderLifeCycle::Converting
+ }
+ }
+ },
+ }
+ }
+
+ /// The `Encoding` this `Decoder` is for.
+ ///
+ /// BOM sniffing can change the return value of this method during the life
+ /// of the decoder.
+ ///
+ /// Available via the C wrapper.
+ #[inline]
+ pub fn encoding(&self) -> &'static Encoding {
+ self.encoding
+ }
+
+ /// Query the worst-case UTF-8 output size _with replacement_.
+ ///
+ /// Returns the size of the output buffer in UTF-8 code units (`u8`)
+ /// that will not overflow given the current state of the decoder and
+ /// `byte_length` number of additional input bytes when decoding with
+ /// errors handled by outputting a REPLACEMENT CHARACTER for each malformed
+ /// sequence or `None` if `usize` would overflow.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_utf8_buffer_length(&self, byte_length: usize) -> Option<usize> {
+ // Need to consider a) the decoder morphing due to the BOM and b) a partial
+ // BOM getting pushed to the underlying decoder.
+ match self.life_cycle {
+ DecoderLifeCycle::Converting
+ | DecoderLifeCycle::AtUtf8Start
+ | DecoderLifeCycle::AtUtf16LeStart
+ | DecoderLifeCycle::AtUtf16BeStart => {
+ return self.variant.max_utf8_buffer_length(byte_length);
+ }
+ DecoderLifeCycle::AtStart => {
+ if let Some(utf8_bom) = checked_add(3, byte_length.checked_mul(3)) {
+ if let Some(utf16_bom) = checked_add(
+ 1,
+ checked_mul(3, checked_div(byte_length.checked_add(1), 2)),
+ ) {
+ let utf_bom = core::cmp::max(utf8_bom, utf16_bom);
+ let encoding = self.encoding();
+ if encoding == UTF_8 || encoding == UTF_16LE || encoding == UTF_16BE {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf_bom);
+ } else if let Some(non_bom) =
+ self.variant.max_utf8_buffer_length(byte_length)
+ {
+ return Some(core::cmp::max(utf_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::SeenUtf8First | DecoderLifeCycle::SeenUtf8Second => {
+ // Add two bytes even when only one byte has been seen,
+ // because the one byte can become a lead byte in multibyte
+ // decoders, but only after the decoder has been queried
+ // for max length, so the decoder's own logic for adding
+ // one for a pending lead cannot work.
+ if let Some(sum) = byte_length.checked_add(2) {
+ if let Some(utf8_bom) = checked_add(3, sum.checked_mul(3)) {
+ if self.encoding() == UTF_8 {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf8_bom);
+ } else if let Some(non_bom) = self.variant.max_utf8_buffer_length(sum) {
+ return Some(core::cmp::max(utf8_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::ConvertingWithPendingBB => {
+ if let Some(sum) = byte_length.checked_add(2) {
+ return self.variant.max_utf8_buffer_length(sum);
+ }
+ }
+ DecoderLifeCycle::SeenUtf16LeFirst | DecoderLifeCycle::SeenUtf16BeFirst => {
+ // Add two bytes even when only one byte has been seen,
+ // because the one byte can become a lead byte in multibyte
+ // decoders, but only after the decoder has been queried
+ // for max length, so the decoder's own logic for adding
+ // one for a pending lead cannot work.
+ if let Some(sum) = byte_length.checked_add(2) {
+ if let Some(utf16_bom) =
+ checked_add(1, checked_mul(3, checked_div(sum.checked_add(1), 2)))
+ {
+ let encoding = self.encoding();
+ if encoding == UTF_16LE || encoding == UTF_16BE {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf16_bom);
+ } else if let Some(non_bom) = self.variant.max_utf8_buffer_length(sum) {
+ return Some(core::cmp::max(utf16_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::Finished => panic!("Must not use a decoder that has finished."),
+ }
+ None
+ }
+
+ /// Query the worst-case UTF-8 output size _without replacement_.
+ ///
+ /// Returns the size of the output buffer in UTF-8 code units (`u8`)
+ /// that will not overflow given the current state of the decoder and
+ /// `byte_length` number of additional input bytes when decoding without
+ /// replacement error handling or `None` if `usize` would overflow.
+ ///
+ /// Note that this value may be too small for the `_with_replacement` case.
+ /// Use `max_utf8_buffer_length()` for that case.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_utf8_buffer_length_without_replacement(&self, byte_length: usize) -> Option<usize> {
+ // Need to consider a) the decoder morphing due to the BOM and b) a partial
+ // BOM getting pushed to the underlying decoder.
+ match self.life_cycle {
+ DecoderLifeCycle::Converting
+ | DecoderLifeCycle::AtUtf8Start
+ | DecoderLifeCycle::AtUtf16LeStart
+ | DecoderLifeCycle::AtUtf16BeStart => {
+ return self
+ .variant
+ .max_utf8_buffer_length_without_replacement(byte_length);
+ }
+ DecoderLifeCycle::AtStart => {
+ if let Some(utf8_bom) = byte_length.checked_add(3) {
+ if let Some(utf16_bom) = checked_add(
+ 1,
+ checked_mul(3, checked_div(byte_length.checked_add(1), 2)),
+ ) {
+ let utf_bom = core::cmp::max(utf8_bom, utf16_bom);
+ let encoding = self.encoding();
+ if encoding == UTF_8 || encoding == UTF_16LE || encoding == UTF_16BE {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf_bom);
+ } else if let Some(non_bom) = self
+ .variant
+ .max_utf8_buffer_length_without_replacement(byte_length)
+ {
+ return Some(core::cmp::max(utf_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::SeenUtf8First | DecoderLifeCycle::SeenUtf8Second => {
+ // Add two bytes even when only one byte has been seen,
+ // because the one byte can become a lead byte in multibyte
+ // decoders, but only after the decoder has been queried
+ // for max length, so the decoder's own logic for adding
+ // one for a pending lead cannot work.
+ if let Some(sum) = byte_length.checked_add(2) {
+ if let Some(utf8_bom) = sum.checked_add(3) {
+ if self.encoding() == UTF_8 {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf8_bom);
+ } else if let Some(non_bom) =
+ self.variant.max_utf8_buffer_length_without_replacement(sum)
+ {
+ return Some(core::cmp::max(utf8_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::ConvertingWithPendingBB => {
+ if let Some(sum) = byte_length.checked_add(2) {
+ return self.variant.max_utf8_buffer_length_without_replacement(sum);
+ }
+ }
+ DecoderLifeCycle::SeenUtf16LeFirst | DecoderLifeCycle::SeenUtf16BeFirst => {
+ // Add two bytes even when only one byte has been seen,
+ // because the one byte can become a lead byte in multibyte
+ // decoders, but only after the decoder has been queried
+ // for max length, so the decoder's own logic for adding
+ // one for a pending lead cannot work.
+ if let Some(sum) = byte_length.checked_add(2) {
+ if let Some(utf16_bom) =
+ checked_add(1, checked_mul(3, checked_div(sum.checked_add(1), 2)))
+ {
+ let encoding = self.encoding();
+ if encoding == UTF_16LE || encoding == UTF_16BE {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf16_bom);
+ } else if let Some(non_bom) =
+ self.variant.max_utf8_buffer_length_without_replacement(sum)
+ {
+ return Some(core::cmp::max(utf16_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::Finished => panic!("Must not use a decoder that has finished."),
+ }
+ None
+ }
+
+ /// Incrementally decode a byte stream into UTF-8 with malformed sequences
+ /// replaced with the REPLACEMENT CHARACTER.
+ ///
+ /// See the documentation of the struct for documentation for `decode_*`
+ /// methods collectively.
+ ///
+ /// Available via the C wrapper.
+ pub fn decode_to_utf8(
+ &mut self,
+ src: &[u8],
+ dst: &mut [u8],
+ last: bool,
+ ) -> (CoderResult, usize, usize, bool) {
+ let mut had_errors = false;
+ let mut total_read = 0usize;
+ let mut total_written = 0usize;
+ loop {
+ let (result, read, written) = self.decode_to_utf8_without_replacement(
+ &src[total_read..],
+ &mut dst[total_written..],
+ last,
+ );
+ total_read += read;
+ total_written += written;
+ match result {
+ DecoderResult::InputEmpty => {
+ return (
+ CoderResult::InputEmpty,
+ total_read,
+ total_written,
+ had_errors,
+ );
+ }
+ DecoderResult::OutputFull => {
+ return (
+ CoderResult::OutputFull,
+ total_read,
+ total_written,
+ had_errors,
+ );
+ }
+ DecoderResult::Malformed(_, _) => {
+ had_errors = true;
+ // There should always be space for the U+FFFD, because
+ // otherwise we'd have gotten OutputFull already.
+ // XXX: is the above comment actually true for UTF-8 itself?
+ // TODO: Consider having fewer bound checks here.
+ dst[total_written] = 0xEFu8;
+ total_written += 1;
+ dst[total_written] = 0xBFu8;
+ total_written += 1;
+ dst[total_written] = 0xBDu8;
+ total_written += 1;
+ }
+ }
+ }
+ }
+
+ /// Incrementally decode a byte stream into UTF-8 with malformed sequences
+ /// replaced with the REPLACEMENT CHARACTER with type system signaling
+ /// of UTF-8 validity.
+ ///
+ /// This methods calls `decode_to_utf8` and then zeroes
+ /// out up to three bytes that aren't logically part of the write in order
+ /// to retain the UTF-8 validity even for the unwritten part of the buffer.
+ ///
+ /// See the documentation of the struct for documentation for `decode_*`
+ /// methods collectively.
+ ///
+ /// Available to Rust only.
+ pub fn decode_to_str(
+ &mut self,
+ src: &[u8],
+ dst: &mut str,
+ last: bool,
+ ) -> (CoderResult, usize, usize, bool) {
+ let bytes: &mut [u8] = unsafe { dst.as_bytes_mut() };
+ let (result, read, written, replaced) = self.decode_to_utf8(src, bytes, last);
+ let len = bytes.len();
+ let mut trail = written;
+ // Non-UTF-8 ASCII-compatible decoders may write up to `MAX_STRIDE_SIZE`
+ // bytes of trailing garbage. No need to optimize non-ASCII-compatible
+ // encodings to avoid overwriting here.
+ if self.encoding != UTF_8 {
+ let max = core::cmp::min(len, trail + ascii::MAX_STRIDE_SIZE);
+ while trail < max {
+ bytes[trail] = 0;
+ trail += 1;
+ }
+ }
+ while trail < len && ((bytes[trail] & 0xC0) == 0x80) {
+ bytes[trail] = 0;
+ trail += 1;
+ }
+ (result, read, written, replaced)
+ }
+
+ /// Incrementally decode a byte stream into UTF-8 with malformed sequences
+ /// replaced with the REPLACEMENT CHARACTER using a `String` receiver.
+ ///
+ /// Like the others, this method follows the logic that the output buffer is
+ /// caller-allocated. This method treats the capacity of the `String` as
+ /// the output limit. That is, this method guarantees not to cause a
+ /// reallocation of the backing buffer of `String`.
+ ///
+ /// The return value is a tuple that contains the `DecoderResult`, the
+ /// number of bytes read and a boolean indicating whether replacements
+ /// were done. The number of bytes written is signaled via the length of
+ /// the `String` changing.
+ ///
+ /// See the documentation of the struct for documentation for `decode_*`
+ /// methods collectively.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn decode_to_string(
+ &mut self,
+ src: &[u8],
+ dst: &mut String,
+ last: bool,
+ ) -> (CoderResult, usize, bool) {
+ unsafe {
+ let vec = dst.as_mut_vec();
+ let old_len = vec.len();
+ let capacity = vec.capacity();
+ vec.set_len(capacity);
+ let (result, read, written, replaced) =
+ self.decode_to_utf8(src, &mut vec[old_len..], last);
+ vec.set_len(old_len + written);
+ (result, read, replaced)
+ }
+ }
+
+ public_decode_function!(/// Incrementally decode a byte stream into UTF-8
+ /// _without replacement_.
+ ///
+ /// See the documentation of the struct for
+ /// documentation for `decode_*` methods
+ /// collectively.
+ ///
+ /// Available via the C wrapper.
+ ,
+ decode_to_utf8_without_replacement,
+ decode_to_utf8_raw,
+ decode_to_utf8_checking_end,
+ decode_to_utf8_after_one_potential_bom_byte,
+ decode_to_utf8_after_two_potential_bom_bytes,
+ decode_to_utf8_checking_end_with_offset,
+ u8);
+
+ /// Incrementally decode a byte stream into UTF-8 with type system signaling
+ /// of UTF-8 validity.
+ ///
+ /// This methods calls `decode_to_utf8` and then zeroes out up to three
+ /// bytes that aren't logically part of the write in order to retain the
+ /// UTF-8 validity even for the unwritten part of the buffer.
+ ///
+ /// See the documentation of the struct for documentation for `decode_*`
+ /// methods collectively.
+ ///
+ /// Available to Rust only.
+ pub fn decode_to_str_without_replacement(
+ &mut self,
+ src: &[u8],
+ dst: &mut str,
+ last: bool,
+ ) -> (DecoderResult, usize, usize) {
+ let bytes: &mut [u8] = unsafe { dst.as_bytes_mut() };
+ let (result, read, written) = self.decode_to_utf8_without_replacement(src, bytes, last);
+ let len = bytes.len();
+ let mut trail = written;
+ // Non-UTF-8 ASCII-compatible decoders may write up to `MAX_STRIDE_SIZE`
+ // bytes of trailing garbage. No need to optimize non-ASCII-compatible
+ // encodings to avoid overwriting here.
+ if self.encoding != UTF_8 {
+ let max = core::cmp::min(len, trail + ascii::MAX_STRIDE_SIZE);
+ while trail < max {
+ bytes[trail] = 0;
+ trail += 1;
+ }
+ }
+ while trail < len && ((bytes[trail] & 0xC0) == 0x80) {
+ bytes[trail] = 0;
+ trail += 1;
+ }
+ (result, read, written)
+ }
+
+ /// Incrementally decode a byte stream into UTF-8 using a `String` receiver.
+ ///
+ /// Like the others, this method follows the logic that the output buffer is
+ /// caller-allocated. This method treats the capacity of the `String` as
+ /// the output limit. That is, this method guarantees not to cause a
+ /// reallocation of the backing buffer of `String`.
+ ///
+ /// The return value is a pair that contains the `DecoderResult` and the
+ /// number of bytes read. The number of bytes written is signaled via
+ /// the length of the `String` changing.
+ ///
+ /// See the documentation of the struct for documentation for `decode_*`
+ /// methods collectively.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn decode_to_string_without_replacement(
+ &mut self,
+ src: &[u8],
+ dst: &mut String,
+ last: bool,
+ ) -> (DecoderResult, usize) {
+ unsafe {
+ let vec = dst.as_mut_vec();
+ let old_len = vec.len();
+ let capacity = vec.capacity();
+ vec.set_len(capacity);
+ let (result, read, written) =
+ self.decode_to_utf8_without_replacement(src, &mut vec[old_len..], last);
+ vec.set_len(old_len + written);
+ (result, read)
+ }
+ }
+
+ /// Query the worst-case UTF-16 output size (with or without replacement).
+ ///
+ /// Returns the size of the output buffer in UTF-16 code units (`u16`)
+ /// that will not overflow given the current state of the decoder and
+ /// `byte_length` number of additional input bytes or `None` if `usize`
+ /// would overflow.
+ ///
+ /// Since the REPLACEMENT CHARACTER fits into one UTF-16 code unit, the
+ /// return value of this method applies also in the
+ /// `_without_replacement` case.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_utf16_buffer_length(&self, byte_length: usize) -> Option<usize> {
+ // Need to consider a) the decoder morphing due to the BOM and b) a partial
+ // BOM getting pushed to the underlying decoder.
+ match self.life_cycle {
+ DecoderLifeCycle::Converting
+ | DecoderLifeCycle::AtUtf8Start
+ | DecoderLifeCycle::AtUtf16LeStart
+ | DecoderLifeCycle::AtUtf16BeStart => {
+ return self.variant.max_utf16_buffer_length(byte_length);
+ }
+ DecoderLifeCycle::AtStart => {
+ if let Some(utf8_bom) = byte_length.checked_add(1) {
+ if let Some(utf16_bom) =
+ checked_add(1, checked_div(byte_length.checked_add(1), 2))
+ {
+ let utf_bom = core::cmp::max(utf8_bom, utf16_bom);
+ let encoding = self.encoding();
+ if encoding == UTF_8 || encoding == UTF_16LE || encoding == UTF_16BE {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf_bom);
+ } else if let Some(non_bom) =
+ self.variant.max_utf16_buffer_length(byte_length)
+ {
+ return Some(core::cmp::max(utf_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::SeenUtf8First | DecoderLifeCycle::SeenUtf8Second => {
+ // Add two bytes even when only one byte has been seen,
+ // because the one byte can become a lead byte in multibyte
+ // decoders, but only after the decoder has been queried
+ // for max length, so the decoder's own logic for adding
+ // one for a pending lead cannot work.
+ if let Some(sum) = byte_length.checked_add(2) {
+ if let Some(utf8_bom) = sum.checked_add(1) {
+ if self.encoding() == UTF_8 {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf8_bom);
+ } else if let Some(non_bom) = self.variant.max_utf16_buffer_length(sum) {
+ return Some(core::cmp::max(utf8_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::ConvertingWithPendingBB => {
+ if let Some(sum) = byte_length.checked_add(2) {
+ return self.variant.max_utf16_buffer_length(sum);
+ }
+ }
+ DecoderLifeCycle::SeenUtf16LeFirst | DecoderLifeCycle::SeenUtf16BeFirst => {
+ // Add two bytes even when only one byte has been seen,
+ // because the one byte can become a lead byte in multibyte
+ // decoders, but only after the decoder has been queried
+ // for max length, so the decoder's own logic for adding
+ // one for a pending lead cannot work.
+ if let Some(sum) = byte_length.checked_add(2) {
+ if let Some(utf16_bom) = checked_add(1, checked_div(sum.checked_add(1), 2)) {
+ let encoding = self.encoding();
+ if encoding == UTF_16LE || encoding == UTF_16BE {
+ // No need to consider the internal state of the underlying decoder,
+ // because it is at start, because no data has reached it yet.
+ return Some(utf16_bom);
+ } else if let Some(non_bom) = self.variant.max_utf16_buffer_length(sum) {
+ return Some(core::cmp::max(utf16_bom, non_bom));
+ }
+ }
+ }
+ }
+ DecoderLifeCycle::Finished => panic!("Must not use a decoder that has finished."),
+ }
+ None
+ }
+
+ /// Incrementally decode a byte stream into UTF-16 with malformed sequences
+ /// replaced with the REPLACEMENT CHARACTER.
+ ///
+ /// See the documentation of the struct for documentation for `decode_*`
+ /// methods collectively.
+ ///
+ /// Available via the C wrapper.
+ pub fn decode_to_utf16(
+ &mut self,
+ src: &[u8],
+ dst: &mut [u16],
+ last: bool,
+ ) -> (CoderResult, usize, usize, bool) {
+ let mut had_errors = false;
+ let mut total_read = 0usize;
+ let mut total_written = 0usize;
+ loop {
+ let (result, read, written) = self.decode_to_utf16_without_replacement(
+ &src[total_read..],
+ &mut dst[total_written..],
+ last,
+ );
+ total_read += read;
+ total_written += written;
+ match result {
+ DecoderResult::InputEmpty => {
+ return (
+ CoderResult::InputEmpty,
+ total_read,
+ total_written,
+ had_errors,
+ );
+ }
+ DecoderResult::OutputFull => {
+ return (
+ CoderResult::OutputFull,
+ total_read,
+ total_written,
+ had_errors,
+ );
+ }
+ DecoderResult::Malformed(_, _) => {
+ had_errors = true;
+ // There should always be space for the U+FFFD, because
+ // otherwise we'd have gotten OutputFull already.
+ dst[total_written] = 0xFFFD;
+ total_written += 1;
+ }
+ }
+ }
+ }
+
+ public_decode_function!(/// Incrementally decode a byte stream into UTF-16
+ /// _without replacement_.
+ ///
+ /// See the documentation of the struct for
+ /// documentation for `decode_*` methods
+ /// collectively.
+ ///
+ /// Available via the C wrapper.
+ ,
+ decode_to_utf16_without_replacement,
+ decode_to_utf16_raw,
+ decode_to_utf16_checking_end,
+ decode_to_utf16_after_one_potential_bom_byte,
+ decode_to_utf16_after_two_potential_bom_bytes,
+ decode_to_utf16_checking_end_with_offset,
+ u16);
+
+ /// Checks for compatibility with storing Unicode scalar values as unsigned
+ /// bytes taking into account the state of the decoder.
+ ///
+ /// Returns `None` if the decoder is not in a neutral state, including waiting
+ /// for the BOM, or if the encoding is never Latin1-byte-compatible.
+ ///
+ /// Otherwise returns the index of the first byte whose unsigned value doesn't
+ /// directly correspond to the decoded Unicode scalar value, or the length
+ /// of the input if all bytes in the input decode directly to scalar values
+ /// corresponding to the unsigned byte values.
+ ///
+ /// Does not change the state of the decoder.
+ ///
+ /// Do not use this unless you are supporting SpiderMonkey/V8-style string
+ /// storage optimizations.
+ ///
+ /// Available via the C wrapper.
+ pub fn latin1_byte_compatible_up_to(&self, bytes: &[u8]) -> Option<usize> {
+ match self.life_cycle {
+ DecoderLifeCycle::Converting => {
+ return self.variant.latin1_byte_compatible_up_to(bytes);
+ }
+ DecoderLifeCycle::Finished => panic!("Must not use a decoder that has finished."),
+ _ => None,
+ }
+ }
+}
+
+/// Result of a (potentially partial) encode operation without replacement.
+#[must_use]
+#[derive(Debug, PartialEq, Eq)]
+pub enum EncoderResult {
+ /// The input was exhausted.
+ ///
+ /// If this result was returned from a call where `last` was `true`, the
+ /// decoding process has completed. Otherwise, the caller should call a
+ /// decode method again with more input.
+ InputEmpty,
+
+ /// The encoder cannot produce another unit of output, because the output
+ /// buffer does not have enough space left.
+ ///
+ /// The caller must provide more output space upon the next call and re-push
+ /// the remaining input to the decoder.
+ OutputFull,
+
+ /// The encoder encountered an unmappable character.
+ ///
+ /// The caller must either treat this as a fatal error or must append
+ /// a placeholder to the output and then re-push the remaining input to the
+ /// encoder.
+ Unmappable(char),
+}
+
+impl EncoderResult {
+ fn unmappable_from_bmp(bmp: u16) -> EncoderResult {
+ EncoderResult::Unmappable(::core::char::from_u32(u32::from(bmp)).unwrap())
+ }
+}
+
+/// A converter that encodes a Unicode stream into bytes according to a
+/// character encoding in a streaming (incremental) manner.
+///
+/// The various `encode_*` methods take an input buffer (`src`) and an output
+/// buffer `dst` both of which are caller-allocated. There are variants for
+/// both UTF-8 and UTF-16 input buffers.
+///
+/// An `encode_*` method encode characters from `src` into bytes characters
+/// stored into `dst` until one of the following three things happens:
+///
+/// 1. An unmappable character is encountered (`*_without_replacement` variants
+/// only).
+///
+/// 2. 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.
+///
+/// 3. All the input characters have been processed.
+///
+/// The `encode_*` method then returns tuple of a status indicating which one
+/// of the three reasons to return happened, how many input code units (`u8`
+/// when encoding from UTF-8 and `u16` when encoding from UTF-16) were read,
+/// how many output bytes were written (except when encoding into `Vec<u8>`,
+/// 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.
+///
+/// The number of bytes "written" is what's logically written. Garbage may be
+/// written in the output buffer beyond the point logically written to.
+///
+/// In the case of the methods whose name ends with
+/// `*_without_replacement`, the status is an [`EncoderResult`][1] enumeration
+/// (possibilities `Unmappable`, `OutputFull` and `InputEmpty` corresponding to
+/// the three cases listed above).
+///
+/// In the case of methods whose name does not end with
+/// `*_without_replacement`, unmappable characters are automatically replaced
+/// with the corresponding numeric character references and unmappable
+/// characters do not cause the methods to return early.
+///
+/// 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
+/// [`max_buffer_length_from_utf8_without_replacement()`][2]. 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
+/// [`max_buffer_length_from_utf8_if_no_unmappables()`][3]. 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
+/// [`max_buffer_length_from_utf16_without_replacement()`][4]. 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
+/// [`max_buffer_length_from_utf16_if_no_unmappables()`][5].
+/// 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.
+///
+/// When encoding from UTF-8, each `src` buffer _must_ 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.
+///
+/// After an `encode_*` 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.)
+///
+/// The boolean argument `last` indicates that the end of the stream is reached
+/// when all the characters in `src` have been consumed. This argument is needed
+/// for ISO-2022-JP and is ignored for other encodings.
+///
+/// An `Encoder` object can be used to incrementally encode a byte stream.
+///
+/// During the processing of a single stream, the caller must call `encode_*`
+/// zero or more times with `last` set to `false` and then call `encode_*` at
+/// least once with `last` set to `true`. If `encode_*` returns `InputEmpty`,
+/// the processing of the stream has ended. Otherwise, the caller must call
+/// `encode_*` again with `last` set to `true` (or treat an `Unmappable` result
+/// as a fatal error).
+///
+/// Once the stream has ended, the `Encoder` object must not be used anymore.
+/// That is, you need to create another one to process another stream.
+///
+/// When the encoder returns `OutputFull` or the encoder returns `Unmappable`
+/// and the caller does not wish to treat it as a fatal error, the input buffer
+/// `src` may not have been completely consumed. In that case, the caller must
+/// pass the unconsumed contents of `src` to `encode_*` again upon the next
+/// call.
+///
+/// [1]: enum.EncoderResult.html
+/// [2]: #method.max_buffer_length_from_utf8_without_replacement
+/// [3]: #method.max_buffer_length_from_utf8_if_no_unmappables
+/// [4]: #method.max_buffer_length_from_utf16_without_replacement
+/// [5]: #method.max_buffer_length_from_utf16_if_no_unmappables
+///
+/// # Infinite loops
+///
+/// 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).
+pub struct Encoder {
+ encoding: &'static Encoding,
+ variant: VariantEncoder,
+}
+
+impl Encoder {
+ fn new(enc: &'static Encoding, encoder: VariantEncoder) -> Encoder {
+ Encoder {
+ encoding: enc,
+ variant: encoder,
+ }
+ }
+
+ /// The `Encoding` this `Encoder` is for.
+ #[inline]
+ pub fn encoding(&self) -> &'static Encoding {
+ self.encoding
+ }
+
+ /// Returns `true` if this is an ISO-2022-JP encoder that's not in the
+ /// ASCII state and `false` otherwise.
+ #[inline]
+ pub fn has_pending_state(&self) -> bool {
+ self.variant.has_pending_state()
+ }
+
+ /// Query the worst-case output size when encoding from UTF-8 with
+ /// replacement.
+ ///
+ /// Returns the size of the output buffer in bytes that will not overflow
+ /// given the current state of the encoder and `byte_length` number of
+ /// additional input code units if there are no unmappable characters in
+ /// the input or `None` if `usize` would overflow.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_buffer_length_from_utf8_if_no_unmappables(
+ &self,
+ byte_length: usize,
+ ) -> Option<usize> {
+ checked_add(
+ if self.encoding().can_encode_everything() {
+ 0
+ } else {
+ NCR_EXTRA
+ },
+ self.max_buffer_length_from_utf8_without_replacement(byte_length),
+ )
+ }
+
+ /// Query the worst-case output size when encoding from UTF-8 without
+ /// replacement.
+ ///
+ /// Returns the size of the output buffer in bytes that will not overflow
+ /// given the current state of the encoder and `byte_length` number of
+ /// additional input code units or `None` if `usize` would overflow.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_buffer_length_from_utf8_without_replacement(
+ &self,
+ byte_length: usize,
+ ) -> Option<usize> {
+ self.variant
+ .max_buffer_length_from_utf8_without_replacement(byte_length)
+ }
+
+ /// Incrementally encode into byte stream from UTF-8 with unmappable
+ /// characters replaced with HTML (decimal) numeric character references.
+ ///
+ /// See the documentation of the struct for documentation for `encode_*`
+ /// methods collectively.
+ ///
+ /// Available via the C wrapper.
+ pub fn encode_from_utf8(
+ &mut self,
+ src: &str,
+ dst: &mut [u8],
+ last: bool,
+ ) -> (CoderResult, usize, usize, bool) {
+ let dst_len = dst.len();
+ let effective_dst_len = if self.encoding().can_encode_everything() {
+ dst_len
+ } else {
+ if dst_len < NCR_EXTRA {
+ if src.is_empty() && !(last && self.has_pending_state()) {
+ return (CoderResult::InputEmpty, 0, 0, false);
+ }
+ return (CoderResult::OutputFull, 0, 0, false);
+ }
+ dst_len - NCR_EXTRA
+ };
+ let mut had_unmappables = false;
+ let mut total_read = 0usize;
+ let mut total_written = 0usize;
+ loop {
+ let (result, read, written) = self.encode_from_utf8_without_replacement(
+ &src[total_read..],
+ &mut dst[total_written..effective_dst_len],
+ last,
+ );
+ total_read += read;
+ total_written += written;
+ match result {
+ EncoderResult::InputEmpty => {
+ return (
+ CoderResult::InputEmpty,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ EncoderResult::OutputFull => {
+ return (
+ CoderResult::OutputFull,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ EncoderResult::Unmappable(unmappable) => {
+ had_unmappables = true;
+ debug_assert!(dst.len() - total_written >= NCR_EXTRA);
+ debug_assert_ne!(self.encoding(), UTF_16BE);
+ debug_assert_ne!(self.encoding(), UTF_16LE);
+ // Additionally, Iso2022JpEncoder is responsible for
+ // transitioning to ASCII when returning with Unmappable.
+ total_written += write_ncr(unmappable, &mut dst[total_written..]);
+ if total_written >= effective_dst_len {
+ if total_read == src.len() && !(last && self.has_pending_state()) {
+ return (
+ CoderResult::InputEmpty,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ return (
+ CoderResult::OutputFull,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ }
+ }
+ }
+ }
+
+ /// Incrementally encode into byte stream from UTF-8 with unmappable
+ /// characters replaced with HTML (decimal) numeric character references.
+ ///
+ /// See the documentation of the struct for documentation for `encode_*`
+ /// methods collectively.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn encode_from_utf8_to_vec(
+ &mut self,
+ src: &str,
+ dst: &mut Vec<u8>,
+ last: bool,
+ ) -> (CoderResult, usize, bool) {
+ unsafe {
+ let old_len = dst.len();
+ let capacity = dst.capacity();
+ dst.set_len(capacity);
+ let (result, read, written, replaced) =
+ self.encode_from_utf8(src, &mut dst[old_len..], last);
+ dst.set_len(old_len + written);
+ (result, read, replaced)
+ }
+ }
+
+ /// Incrementally encode into byte stream from UTF-8 _without replacement_.
+ ///
+ /// See the documentation of the struct for documentation for `encode_*`
+ /// methods collectively.
+ ///
+ /// Available via the C wrapper.
+ pub fn encode_from_utf8_without_replacement(
+ &mut self,
+ src: &str,
+ dst: &mut [u8],
+ last: bool,
+ ) -> (EncoderResult, usize, usize) {
+ self.variant.encode_from_utf8_raw(src, dst, last)
+ }
+
+ /// Incrementally encode into byte stream from UTF-8 _without replacement_.
+ ///
+ /// See the documentation of the struct for documentation for `encode_*`
+ /// methods collectively.
+ ///
+ /// Available to Rust only and only with the `alloc` feature enabled (enabled
+ /// by default).
+ #[cfg(feature = "alloc")]
+ pub fn encode_from_utf8_to_vec_without_replacement(
+ &mut self,
+ src: &str,
+ dst: &mut Vec<u8>,
+ last: bool,
+ ) -> (EncoderResult, usize) {
+ unsafe {
+ let old_len = dst.len();
+ let capacity = dst.capacity();
+ dst.set_len(capacity);
+ let (result, read, written) =
+ self.encode_from_utf8_without_replacement(src, &mut dst[old_len..], last);
+ dst.set_len(old_len + written);
+ (result, read)
+ }
+ }
+
+ /// Query the worst-case output size when encoding from UTF-16 with
+ /// replacement.
+ ///
+ /// Returns the size of the output buffer in bytes that will not overflow
+ /// given the current state of the encoder and `u16_length` number of
+ /// additional input code units if there are no unmappable characters in
+ /// the input or `None` if `usize` would overflow.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_buffer_length_from_utf16_if_no_unmappables(
+ &self,
+ u16_length: usize,
+ ) -> Option<usize> {
+ checked_add(
+ if self.encoding().can_encode_everything() {
+ 0
+ } else {
+ NCR_EXTRA
+ },
+ self.max_buffer_length_from_utf16_without_replacement(u16_length),
+ )
+ }
+
+ /// Query the worst-case output size when encoding from UTF-16 without
+ /// replacement.
+ ///
+ /// Returns the size of the output buffer in bytes that will not overflow
+ /// given the current state of the encoder and `u16_length` number of
+ /// additional input code units or `None` if `usize` would overflow.
+ ///
+ /// Available via the C wrapper.
+ pub fn max_buffer_length_from_utf16_without_replacement(
+ &self,
+ u16_length: usize,
+ ) -> Option<usize> {
+ self.variant
+ .max_buffer_length_from_utf16_without_replacement(u16_length)
+ }
+
+ /// Incrementally encode into byte stream from UTF-16 with unmappable
+ /// characters replaced with HTML (decimal) numeric character references.
+ ///
+ /// See the documentation of the struct for documentation for `encode_*`
+ /// methods collectively.
+ ///
+ /// Available via the C wrapper.
+ pub fn encode_from_utf16(
+ &mut self,
+ src: &[u16],
+ dst: &mut [u8],
+ last: bool,
+ ) -> (CoderResult, usize, usize, bool) {
+ let dst_len = dst.len();
+ let effective_dst_len = if self.encoding().can_encode_everything() {
+ dst_len
+ } else {
+ if dst_len < NCR_EXTRA {
+ if src.is_empty() && !(last && self.has_pending_state()) {
+ return (CoderResult::InputEmpty, 0, 0, false);
+ }
+ return (CoderResult::OutputFull, 0, 0, false);
+ }
+ dst_len - NCR_EXTRA
+ };
+ let mut had_unmappables = false;
+ let mut total_read = 0usize;
+ let mut total_written = 0usize;
+ loop {
+ let (result, read, written) = self.encode_from_utf16_without_replacement(
+ &src[total_read..],
+ &mut dst[total_written..effective_dst_len],
+ last,
+ );
+ total_read += read;
+ total_written += written;
+ match result {
+ EncoderResult::InputEmpty => {
+ return (
+ CoderResult::InputEmpty,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ EncoderResult::OutputFull => {
+ return (
+ CoderResult::OutputFull,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ EncoderResult::Unmappable(unmappable) => {
+ had_unmappables = true;
+ debug_assert!(dst.len() - total_written >= NCR_EXTRA);
+ // There are no UTF-16 encoders and even if there were,
+ // they'd never have unmappables.
+ debug_assert_ne!(self.encoding(), UTF_16BE);
+ debug_assert_ne!(self.encoding(), UTF_16LE);
+ // Additionally, Iso2022JpEncoder is responsible for
+ // transitioning to ASCII when returning with Unmappable
+ // from the jis0208 state. That is, when we encode
+ // ISO-2022-JP and come here, the encoder is in either the
+ // ASCII or the Roman state. We are allowed to generate any
+ // printable ASCII excluding \ and ~.
+ total_written += write_ncr(unmappable, &mut dst[total_written..]);
+ if total_written >= effective_dst_len {
+ if total_read == src.len() && !(last && self.has_pending_state()) {
+ return (
+ CoderResult::InputEmpty,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ return (
+ CoderResult::OutputFull,
+ total_read,
+ total_written,
+ had_unmappables,
+ );
+ }
+ }
+ }
+ }
+ }
+
+ /// Incrementally encode into byte stream from UTF-16 _without replacement_.
+ ///
+ /// See the documentation of the struct for documentation for `encode_*`
+ /// methods collectively.
+ ///
+ /// Available via the C wrapper.
+ pub fn encode_from_utf16_without_replacement(
+ &mut self,
+ src: &[u16],
+ dst: &mut [u8],
+ last: bool,
+ ) -> (EncoderResult, usize, usize) {
+ self.variant.encode_from_utf16_raw(src, dst, last)
+ }
+}
+
+/// Format an unmappable as NCR without heap allocation.
+fn write_ncr(unmappable: char, dst: &mut [u8]) -> usize {
+ // len is the number of decimal digits needed to represent unmappable plus
+ // 3 (the length of "&#" and ";").
+ let mut number = unmappable as u32;
+ let len = if number >= 1_000_000u32 {
+ 10usize
+ } else if number >= 100_000u32 {
+ 9usize
+ } else if number >= 10_000u32 {
+ 8usize
+ } else if number >= 1_000u32 {
+ 7usize
+ } else if number >= 100u32 {
+ 6usize
+ } else {
+ // Review the outcome of https://github.com/whatwg/encoding/issues/15
+ // to see if this case is possible
+ 5usize
+ };
+ debug_assert!(number >= 10u32);
+ debug_assert!(len <= dst.len());
+ let mut pos = len - 1;
+ dst[pos] = b';';
+ pos -= 1;
+ loop {
+ let rightmost = number % 10;
+ dst[pos] = rightmost as u8 + b'0';
+ pos -= 1;
+ if number < 10 {
+ break;
+ }
+ number /= 10;
+ }
+ dst[1] = b'#';
+ dst[0] = b'&';
+ len
+}
+
+#[inline(always)]
+fn in_range16(i: u16, start: u16, end: u16) -> bool {
+ i.wrapping_sub(start) < (end - start)
+}
+
+#[inline(always)]
+fn in_range32(i: u32, start: u32, end: u32) -> bool {
+ i.wrapping_sub(start) < (end - start)
+}
+
+#[inline(always)]
+fn in_inclusive_range8(i: u8, start: u8, end: u8) -> bool {
+ i.wrapping_sub(start) <= (end - start)
+}
+
+#[inline(always)]
+fn in_inclusive_range16(i: u16, start: u16, end: u16) -> bool {
+ i.wrapping_sub(start) <= (end - start)
+}
+
+#[inline(always)]
+fn in_inclusive_range32(i: u32, start: u32, end: u32) -> bool {
+ i.wrapping_sub(start) <= (end - start)
+}
+
+#[inline(always)]
+fn in_inclusive_range(i: usize, start: usize, end: usize) -> bool {
+ i.wrapping_sub(start) <= (end - start)
+}
+
+#[inline(always)]
+fn checked_add(num: usize, opt: Option<usize>) -> Option<usize> {
+ if let Some(n) = opt {
+ n.checked_add(num)
+ } else {
+ None
+ }
+}
+
+#[inline(always)]
+fn checked_add_opt(one: Option<usize>, other: Option<usize>) -> Option<usize> {
+ if let Some(n) = one {
+ checked_add(n, other)
+ } else {
+ None
+ }
+}
+
+#[inline(always)]
+fn checked_mul(num: usize, opt: Option<usize>) -> Option<usize> {
+ if let Some(n) = opt {
+ n.checked_mul(num)
+ } else {
+ None
+ }
+}
+
+#[inline(always)]
+fn checked_div(opt: Option<usize>, num: usize) -> Option<usize> {
+ if let Some(n) = opt {
+ n.checked_div(num)
+ } else {
+ None
+ }
+}
+
+#[cfg(feature = "alloc")]
+#[inline(always)]
+fn checked_next_power_of_two(opt: Option<usize>) -> Option<usize> {
+ opt.map(|n| n.next_power_of_two())
+}
+
+#[cfg(feature = "alloc")]
+#[inline(always)]
+fn checked_min(one: Option<usize>, other: Option<usize>) -> Option<usize> {
+ if let Some(a) = one {
+ if let Some(b) = other {
+ Some(::core::cmp::min(a, b))
+ } else {
+ Some(a)
+ }
+ } else {
+ other
+ }
+}
+
+// ############## TESTS ###############
+
+#[cfg(all(test, feature = "serde"))]
+#[derive(Serialize, Deserialize, Debug, PartialEq)]
+struct Demo {
+ num: u32,
+ name: String,
+ enc: &'static Encoding,
+}
+
+#[cfg(test)]
+mod test_labels_names;
+
+#[cfg(all(test, feature = "alloc"))]
+mod tests {
+ use super::*;
+ use alloc::borrow::Cow;
+
+ fn sniff_to_utf16(
+ initial_encoding: &'static Encoding,
+ expected_encoding: &'static Encoding,
+ bytes: &[u8],
+ expect: &[u16],
+ breaks: &[usize],
+ ) {
+ let mut decoder = initial_encoding.new_decoder();
+
+ let mut dest: Vec<u16> =
+ Vec::with_capacity(decoder.max_utf16_buffer_length(bytes.len()).unwrap());
+ let capacity = dest.capacity();
+ dest.resize(capacity, 0u16);
+
+ let mut total_written = 0usize;
+ let mut start = 0usize;
+ for br in breaks {
+ let (result, read, written, _) =
+ decoder.decode_to_utf16(&bytes[start..*br], &mut dest[total_written..], false);
+ total_written += written;
+ assert_eq!(read, *br - start);
+ match result {
+ CoderResult::InputEmpty => {}
+ CoderResult::OutputFull => {
+ unreachable!();
+ }
+ }
+ start = *br;
+ }
+ let (result, read, written, _) =
+ decoder.decode_to_utf16(&bytes[start..], &mut dest[total_written..], true);
+ total_written += written;
+ match result {
+ CoderResult::InputEmpty => {}
+ CoderResult::OutputFull => {
+ unreachable!();
+ }
+ }
+ assert_eq!(read, bytes.len() - start);
+ assert_eq!(total_written, expect.len());
+ assert_eq!(&dest[..total_written], expect);
+ assert_eq!(decoder.encoding(), expected_encoding);
+ }
+
+ // Any copyright to the test code below this comment is dedicated to the
+ // Public Domain. http://creativecommons.org/publicdomain/zero/1.0/
+
+ #[test]
+ fn test_bom_sniffing() {
+ // ASCII
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[],
+ );
+ // UTF-8
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[1],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[2],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[3],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[4],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[2, 3],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[1, 2],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[1, 3],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ UTF_8,
+ b"\xEF\xBB\xBF\x61\x62",
+ &[0x0061u16, 0x0062u16],
+ &[1, 2, 3, 4],
+ );
+ sniff_to_utf16(WINDOWS_1252, UTF_8, b"\xEF\xBB\xBF", &[], &[]);
+ // Not UTF-8
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xEF\xBB\x61\x62",
+ &[0x00EFu16, 0x00BBu16, 0x0061u16, 0x0062u16],
+ &[],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xEF\xBB\x61\x62",
+ &[0x00EFu16, 0x00BBu16, 0x0061u16, 0x0062u16],
+ &[1],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xEF\x61\x62",
+ &[0x00EFu16, 0x0061u16, 0x0062u16],
+ &[],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xEF\x61\x62",
+ &[0x00EFu16, 0x0061u16, 0x0062u16],
+ &[1],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xEF\xBB",
+ &[0x00EFu16, 0x00BBu16],
+ &[],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xEF\xBB",
+ &[0x00EFu16, 0x00BBu16],
+ &[1],
+ );
+ sniff_to_utf16(WINDOWS_1252, WINDOWS_1252, b"\xEF", &[0x00EFu16], &[]);
+ // Not UTF-16
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xFE\x61\x62",
+ &[0x00FEu16, 0x0061u16, 0x0062u16],
+ &[],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xFE\x61\x62",
+ &[0x00FEu16, 0x0061u16, 0x0062u16],
+ &[1],
+ );
+ sniff_to_utf16(WINDOWS_1252, WINDOWS_1252, b"\xFE", &[0x00FEu16], &[]);
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xFF\x61\x62",
+ &[0x00FFu16, 0x0061u16, 0x0062u16],
+ &[],
+ );
+ sniff_to_utf16(
+ WINDOWS_1252,
+ WINDOWS_1252,
+ b"\xFF\x61\x62",
+ &[0x00FFu16, 0x0061u16, 0x0062u16],
+ &[1],
+ );
+ sniff_to_utf16(WINDOWS_1252, WINDOWS_1252, b"\xFF", &[0x00FFu16], &[]);
+ // UTF-16
+ sniff_to_utf16(WINDOWS_1252, UTF_16BE, b"\xFE\xFF", &[], &[]);
+ sniff_to_utf16(WINDOWS_1252, UTF_16BE, b"\xFE\xFF", &[], &[1]);
+ sniff_to_utf16(WINDOWS_1252, UTF_16LE, b"\xFF\xFE", &[], &[]);
+ sniff_to_utf16(WINDOWS_1252, UTF_16LE, b"\xFF\xFE", &[], &[1]);
+ }
+
+ #[test]
+ fn test_output_encoding() {
+ assert_eq!(REPLACEMENT.output_encoding(), UTF_8);
+ assert_eq!(UTF_16BE.output_encoding(), UTF_8);
+ assert_eq!(UTF_16LE.output_encoding(), UTF_8);
+ assert_eq!(UTF_8.output_encoding(), UTF_8);
+ assert_eq!(WINDOWS_1252.output_encoding(), WINDOWS_1252);
+ assert_eq!(REPLACEMENT.new_encoder().encoding(), UTF_8);
+ assert_eq!(UTF_16BE.new_encoder().encoding(), UTF_8);
+ assert_eq!(UTF_16LE.new_encoder().encoding(), UTF_8);
+ assert_eq!(UTF_8.new_encoder().encoding(), UTF_8);
+ assert_eq!(WINDOWS_1252.new_encoder().encoding(), WINDOWS_1252);
+ }
+
+ #[test]
+ fn test_label_resolution() {
+ assert_eq!(Encoding::for_label(b"utf-8"), Some(UTF_8));
+ assert_eq!(Encoding::for_label(b"UTF-8"), Some(UTF_8));
+ assert_eq!(
+ Encoding::for_label(b" \t \n \x0C \n utf-8 \r \n \t \x0C "),
+ Some(UTF_8)
+ );
+ assert_eq!(Encoding::for_label(b"utf-8 _"), None);
+ assert_eq!(Encoding::for_label(b"bogus"), None);
+ assert_eq!(Encoding::for_label(b"bogusbogusbogusbogus"), None);
+ }
+
+ #[test]
+ fn test_decode_valid_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) = WINDOWS_1257.decode(b"abc\x80\xE4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{00E4}");
+ }
+ }
+ assert_eq!(encoding, WINDOWS_1257);
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_invalid_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) = WINDOWS_1257.decode(b"abc\x80\xA1\xE4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{FFFD}\u{00E4}");
+ }
+ }
+ assert_eq!(encoding, WINDOWS_1257);
+ assert!(had_errors);
+ }
+
+ #[test]
+ fn test_decode_ascii_only_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) = WINDOWS_1257.decode(b"abc");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "abc");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert_eq!(encoding, WINDOWS_1257);
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_valid_utf8_as_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) = WINDOWS_1257.decode(b"\xEF\xBB\xBF\xE2\x82\xAC\xC3\xA4");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "\u{20AC}\u{00E4}");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert_eq!(encoding, UTF_8);
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_invalid_utf8_as_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) =
+ WINDOWS_1257.decode(b"\xEF\xBB\xBF\xE2\x82\xAC\x80\xC3\xA4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "\u{20AC}\u{FFFD}\u{00E4}");
+ }
+ }
+ assert_eq!(encoding, UTF_8);
+ assert!(had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_valid_utf8_as_utf_8_to_cow() {
+ let (cow, encoding, had_errors) = UTF_8.decode(b"\xEF\xBB\xBF\xE2\x82\xAC\xC3\xA4");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "\u{20AC}\u{00E4}");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert_eq!(encoding, UTF_8);
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_invalid_utf8_as_utf_8_to_cow() {
+ let (cow, encoding, had_errors) = UTF_8.decode(b"\xEF\xBB\xBF\xE2\x82\xAC\x80\xC3\xA4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "\u{20AC}\u{FFFD}\u{00E4}");
+ }
+ }
+ assert_eq!(encoding, UTF_8);
+ assert!(had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_valid_utf8_as_utf_8_to_cow_with_bom_removal() {
+ let (cow, had_errors) = UTF_8.decode_with_bom_removal(b"\xEF\xBB\xBF\xE2\x82\xAC\xC3\xA4");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "\u{20AC}\u{00E4}");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_valid_utf8_as_windows_1257_to_cow_with_bom_removal() {
+ let (cow, had_errors) =
+ WINDOWS_1257.decode_with_bom_removal(b"\xEF\xBB\xBF\xE2\x82\xAC\xC3\xA4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(
+ s,
+ "\u{013C}\u{00BB}\u{00E6}\u{0101}\u{201A}\u{00AC}\u{0106}\u{00A4}"
+ );
+ }
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_valid_windows_1257_to_cow_with_bom_removal() {
+ let (cow, had_errors) = WINDOWS_1257.decode_with_bom_removal(b"abc\x80\xE4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{00E4}");
+ }
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_invalid_windows_1257_to_cow_with_bom_removal() {
+ let (cow, had_errors) = WINDOWS_1257.decode_with_bom_removal(b"abc\x80\xA1\xE4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{FFFD}\u{00E4}");
+ }
+ }
+ assert!(had_errors);
+ }
+
+ #[test]
+ fn test_decode_ascii_only_windows_1257_to_cow_with_bom_removal() {
+ let (cow, had_errors) = WINDOWS_1257.decode_with_bom_removal(b"abc");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "abc");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_valid_utf8_to_cow_without_bom_handling() {
+ let (cow, had_errors) =
+ UTF_8.decode_without_bom_handling(b"\xEF\xBB\xBF\xE2\x82\xAC\xC3\xA4");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "\u{FEFF}\u{20AC}\u{00E4}");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_invalid_utf8_to_cow_without_bom_handling() {
+ let (cow, had_errors) =
+ UTF_8.decode_without_bom_handling(b"\xEF\xBB\xBF\xE2\x82\xAC\x80\xC3\xA4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "\u{FEFF}\u{20AC}\u{FFFD}\u{00E4}");
+ }
+ }
+ assert!(had_errors);
+ }
+
+ #[test]
+ fn test_decode_valid_windows_1257_to_cow_without_bom_handling() {
+ let (cow, had_errors) = WINDOWS_1257.decode_without_bom_handling(b"abc\x80\xE4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{00E4}");
+ }
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_invalid_windows_1257_to_cow_without_bom_handling() {
+ let (cow, had_errors) = WINDOWS_1257.decode_without_bom_handling(b"abc\x80\xA1\xE4");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{FFFD}\u{00E4}");
+ }
+ }
+ assert!(had_errors);
+ }
+
+ #[test]
+ fn test_decode_ascii_only_windows_1257_to_cow_without_bom_handling() {
+ let (cow, had_errors) = WINDOWS_1257.decode_without_bom_handling(b"abc");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "abc");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_decode_bomful_valid_utf8_to_cow_without_bom_handling_and_without_replacement() {
+ match UTF_8.decode_without_bom_handling_and_without_replacement(
+ b"\xEF\xBB\xBF\xE2\x82\xAC\xC3\xA4",
+ ) {
+ Some(cow) => match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "\u{FEFF}\u{20AC}\u{00E4}");
+ }
+ Cow::Owned(_) => unreachable!(),
+ },
+ None => unreachable!(),
+ }
+ }
+
+ #[test]
+ fn test_decode_bomful_invalid_utf8_to_cow_without_bom_handling_and_without_replacement() {
+ assert!(UTF_8
+ .decode_without_bom_handling_and_without_replacement(
+ b"\xEF\xBB\xBF\xE2\x82\xAC\x80\xC3\xA4"
+ )
+ .is_none());
+ }
+
+ #[test]
+ fn test_decode_valid_windows_1257_to_cow_without_bom_handling_and_without_replacement() {
+ match WINDOWS_1257.decode_without_bom_handling_and_without_replacement(b"abc\x80\xE4") {
+ Some(cow) => match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, "abc\u{20AC}\u{00E4}");
+ }
+ },
+ None => unreachable!(),
+ }
+ }
+
+ #[test]
+ fn test_decode_invalid_windows_1257_to_cow_without_bom_handling_and_without_replacement() {
+ assert!(WINDOWS_1257
+ .decode_without_bom_handling_and_without_replacement(b"abc\x80\xA1\xE4")
+ .is_none());
+ }
+
+ #[test]
+ fn test_decode_ascii_only_windows_1257_to_cow_without_bom_handling_and_without_replacement() {
+ match WINDOWS_1257.decode_without_bom_handling_and_without_replacement(b"abc") {
+ Some(cow) => match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, "abc");
+ }
+ Cow::Owned(_) => unreachable!(),
+ },
+ None => unreachable!(),
+ }
+ }
+
+ #[test]
+ fn test_encode_ascii_only_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) = WINDOWS_1257.encode("abc");
+ match cow {
+ Cow::Borrowed(s) => {
+ assert_eq!(s, b"abc");
+ }
+ Cow::Owned(_) => unreachable!(),
+ }
+ assert_eq!(encoding, WINDOWS_1257);
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_encode_valid_windows_1257_to_cow() {
+ let (cow, encoding, had_errors) = WINDOWS_1257.encode("abc\u{20AC}\u{00E4}");
+ match cow {
+ Cow::Borrowed(_) => unreachable!(),
+ Cow::Owned(s) => {
+ assert_eq!(s, b"abc\x80\xE4");
+ }
+ }
+ assert_eq!(encoding, WINDOWS_1257);
+ assert!(!had_errors);
+ }
+
+ #[test]
+ fn test_utf16_space_with_one_bom_byte() {
+ let mut decoder = UTF_16LE.new_decoder();
+ let mut dst = [0u16; 12];
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF", &mut dst[..needed], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF", &mut dst[..needed], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_utf8_space_with_one_bom_byte() {
+ let mut decoder = UTF_8.new_decoder();
+ let mut dst = [0u16; 12];
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF", &mut dst[..needed], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF", &mut dst[..needed], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_utf16_space_with_two_bom_bytes() {
+ let mut decoder = UTF_16LE.new_decoder();
+ let mut dst = [0u16; 12];
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xEF", &mut dst[..needed], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xBB", &mut dst[..needed], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF", &mut dst[..needed], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_utf8_space_with_two_bom_bytes() {
+ let mut decoder = UTF_8.new_decoder();
+ let mut dst = [0u16; 12];
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xEF", &mut dst[..needed], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xBB", &mut dst[..needed], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let needed = decoder.max_utf16_buffer_length(1).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF", &mut dst[..needed], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_utf16_space_with_one_bom_byte_and_a_second_byte_in_same_call() {
+ let mut decoder = UTF_16LE.new_decoder();
+ let mut dst = [0u16; 12];
+ {
+ let needed = decoder.max_utf16_buffer_length(2).unwrap();
+ let (result, _, _, _) = decoder.decode_to_utf16(b"\xFF\xFF", &mut dst[..needed], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_too_short_buffer_with_iso_2022_jp_ascii_from_utf8() {
+ let mut dst = [0u8; 8];
+ let mut encoder = ISO_2022_JP.new_encoder();
+ {
+ let (result, _, _, _) = encoder.encode_from_utf8("", &mut dst[..], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let (result, _, _, _) = encoder.encode_from_utf8("", &mut dst[..], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_too_short_buffer_with_iso_2022_jp_roman_from_utf8() {
+ let mut dst = [0u8; 16];
+ let mut encoder = ISO_2022_JP.new_encoder();
+ {
+ let (result, _, _, _) = encoder.encode_from_utf8("\u{A5}", &mut dst[..], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let (result, _, _, _) = encoder.encode_from_utf8("", &mut dst[..8], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let (result, _, _, _) = encoder.encode_from_utf8("", &mut dst[..8], true);
+ assert_eq!(result, CoderResult::OutputFull);
+ }
+ }
+
+ #[test]
+ fn test_buffer_end_iso_2022_jp_from_utf8() {
+ let mut dst = [0u8; 18];
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf8("\u{A5}\u{1F4A9}", &mut dst[..], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) = encoder.encode_from_utf8("\u{A5}\u{1F4A9}", &mut dst[..], true);
+ assert_eq!(result, CoderResult::OutputFull);
+ }
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) = encoder.encode_from_utf8("\u{1F4A9}", &mut dst[..13], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) = encoder.encode_from_utf8("\u{1F4A9}", &mut dst[..13], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_too_short_buffer_with_iso_2022_jp_ascii_from_utf16() {
+ let mut dst = [0u8; 8];
+ let mut encoder = ISO_2022_JP.new_encoder();
+ {
+ let (result, _, _, _) = encoder.encode_from_utf16(&[0u16; 0], &mut dst[..], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let (result, _, _, _) = encoder.encode_from_utf16(&[0u16; 0], &mut dst[..], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_too_short_buffer_with_iso_2022_jp_roman_from_utf16() {
+ let mut dst = [0u8; 16];
+ let mut encoder = ISO_2022_JP.new_encoder();
+ {
+ let (result, _, _, _) = encoder.encode_from_utf16(&[0xA5u16], &mut dst[..], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let (result, _, _, _) = encoder.encode_from_utf16(&[0u16; 0], &mut dst[..8], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let (result, _, _, _) = encoder.encode_from_utf16(&[0u16; 0], &mut dst[..8], true);
+ assert_eq!(result, CoderResult::OutputFull);
+ }
+ }
+
+ #[test]
+ fn test_buffer_end_iso_2022_jp_from_utf16() {
+ let mut dst = [0u8; 18];
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf16(&[0xA5u16, 0xD83Du16, 0xDCA9u16], &mut dst[..], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf16(&[0xA5u16, 0xD83Du16, 0xDCA9u16], &mut dst[..], true);
+ assert_eq!(result, CoderResult::OutputFull);
+ }
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf16(&[0xD83Du16, 0xDCA9u16], &mut dst[..13], false);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf16(&[0xD83Du16, 0xDCA9u16], &mut dst[..13], true);
+ assert_eq!(result, CoderResult::InputEmpty);
+ }
+ }
+
+ #[test]
+ fn test_buffer_end_utf16be() {
+ let mut decoder = UTF_16BE.new_decoder_without_bom_handling();
+ let mut dest = [0u8; 4];
+
+ assert_eq!(
+ decoder.decode_to_utf8(&[0xD8, 0x00], &mut dest, false),
+ (CoderResult::InputEmpty, 2, 0, false)
+ );
+
+ let _ = decoder.decode_to_utf8(&[0xD8, 0x00], &mut dest, true);
+ }
+
+ #[test]
+ fn test_hash() {
+ let mut encodings = ::alloc::collections::btree_set::BTreeSet::new();
+ encodings.insert(UTF_8);
+ encodings.insert(ISO_2022_JP);
+ assert!(encodings.contains(UTF_8));
+ assert!(encodings.contains(ISO_2022_JP));
+ assert!(!encodings.contains(WINDOWS_1252));
+ encodings.remove(ISO_2022_JP);
+ assert!(!encodings.contains(ISO_2022_JP));
+ }
+
+ #[test]
+ fn test_iso_2022_jp_ncr_extra_from_utf16() {
+ let mut dst = [0u8; 17];
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf16(&[0x3041u16, 0xFFFFu16], &mut dst[..], true);
+ assert_eq!(result, CoderResult::OutputFull);
+ }
+ }
+
+ #[test]
+ fn test_iso_2022_jp_ncr_extra_from_utf8() {
+ let mut dst = [0u8; 17];
+ {
+ let mut encoder = ISO_2022_JP.new_encoder();
+ let (result, _, _, _) =
+ encoder.encode_from_utf8("\u{3041}\u{FFFF}", &mut dst[..], true);
+ assert_eq!(result, CoderResult::OutputFull);
+ }
+ }
+
+ #[test]
+ fn test_max_length_with_bom_to_utf8() {
+ let mut output = [0u8; 20];
+ let mut decoder = REPLACEMENT.new_decoder();
+ let input = b"\xEF\xBB\xBFA";
+ {
+ let needed = decoder
+ .max_utf8_buffer_length_without_replacement(input.len())
+ .unwrap();
+ let (result, read, written) =
+ decoder.decode_to_utf8_without_replacement(input, &mut output[..needed], true);
+ assert_eq!(result, DecoderResult::InputEmpty);
+ assert_eq!(read, input.len());
+ assert_eq!(written, 1);
+ assert_eq!(output[0], 0x41);
+ }
+ }
+
+ #[cfg(feature = "serde")]
+ #[test]
+ fn test_serde() {
+ let demo = Demo {
+ num: 42,
+ name: "foo".into(),
+ enc: UTF_8,
+ };
+
+ let serialized = serde_json::to_string(&demo).unwrap();
+
+ let deserialized: Demo = serde_json::from_str(&serialized).unwrap();
+ assert_eq!(deserialized, demo);
+
+ let bincoded = bincode::serialize(&demo).unwrap();
+ let debincoded: Demo = bincode::deserialize(&bincoded[..]).unwrap();
+ assert_eq!(debincoded, demo);
+ }
+
+ #[test]
+ fn test_is_single_byte() {
+ assert!(!BIG5.is_single_byte());
+ assert!(!EUC_JP.is_single_byte());
+ assert!(!EUC_KR.is_single_byte());
+ assert!(!GB18030.is_single_byte());
+ assert!(!GBK.is_single_byte());
+ assert!(!REPLACEMENT.is_single_byte());
+ assert!(!SHIFT_JIS.is_single_byte());
+ assert!(!UTF_8.is_single_byte());
+ assert!(!UTF_16BE.is_single_byte());
+ assert!(!UTF_16LE.is_single_byte());
+ assert!(!ISO_2022_JP.is_single_byte());
+
+ assert!(IBM866.is_single_byte());
+ assert!(ISO_8859_2.is_single_byte());
+ assert!(ISO_8859_3.is_single_byte());
+ assert!(ISO_8859_4.is_single_byte());
+ assert!(ISO_8859_5.is_single_byte());
+ assert!(ISO_8859_6.is_single_byte());
+ assert!(ISO_8859_7.is_single_byte());
+ assert!(ISO_8859_8.is_single_byte());
+ assert!(ISO_8859_10.is_single_byte());
+ assert!(ISO_8859_13.is_single_byte());
+ assert!(ISO_8859_14.is_single_byte());
+ assert!(ISO_8859_15.is_single_byte());
+ assert!(ISO_8859_16.is_single_byte());
+ assert!(ISO_8859_8_I.is_single_byte());
+ assert!(KOI8_R.is_single_byte());
+ assert!(KOI8_U.is_single_byte());
+ assert!(MACINTOSH.is_single_byte());
+ assert!(WINDOWS_874.is_single_byte());
+ assert!(WINDOWS_1250.is_single_byte());
+ assert!(WINDOWS_1251.is_single_byte());
+ assert!(WINDOWS_1252.is_single_byte());
+ assert!(WINDOWS_1253.is_single_byte());
+ assert!(WINDOWS_1254.is_single_byte());
+ assert!(WINDOWS_1255.is_single_byte());
+ assert!(WINDOWS_1256.is_single_byte());
+ assert!(WINDOWS_1257.is_single_byte());
+ assert!(WINDOWS_1258.is_single_byte());
+ assert!(X_MAC_CYRILLIC.is_single_byte());
+ assert!(X_USER_DEFINED.is_single_byte());
+ }
+
+ #[test]
+ fn test_latin1_byte_compatible_up_to() {
+ let buffer = b"a\x81\xB6\xF6\xF0\x82\xB4";
+ assert_eq!(
+ BIG5.new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ EUC_JP
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ EUC_KR
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ GB18030
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ GBK.new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert!(REPLACEMENT
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .is_none());
+ assert_eq!(
+ SHIFT_JIS
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ UTF_8
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert!(UTF_16BE
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .is_none());
+ assert!(UTF_16LE
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .is_none());
+ assert_eq!(
+ ISO_2022_JP
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+
+ assert_eq!(
+ IBM866
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ ISO_8859_2
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_3
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_4
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_5
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_6
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_7
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_8
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 3
+ );
+ assert_eq!(
+ ISO_8859_10
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ ISO_8859_13
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ ISO_8859_14
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ ISO_8859_15
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 6
+ );
+ assert_eq!(
+ ISO_8859_16
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ ISO_8859_8_I
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 3
+ );
+ assert_eq!(
+ KOI8_R
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ KOI8_U
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ MACINTOSH
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ WINDOWS_874
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 2
+ );
+ assert_eq!(
+ WINDOWS_1250
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ WINDOWS_1251
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ WINDOWS_1252
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 5
+ );
+ assert_eq!(
+ WINDOWS_1253
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 3
+ );
+ assert_eq!(
+ WINDOWS_1254
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ WINDOWS_1255
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 3
+ );
+ assert_eq!(
+ WINDOWS_1256
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ WINDOWS_1257
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ WINDOWS_1258
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 4
+ );
+ assert_eq!(
+ X_MAC_CYRILLIC
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+ assert_eq!(
+ X_USER_DEFINED
+ .new_decoder_without_bom_handling()
+ .latin1_byte_compatible_up_to(buffer)
+ .unwrap(),
+ 1
+ );
+
+ assert!(UTF_8
+ .new_decoder()
+ .latin1_byte_compatible_up_to(buffer)
+ .is_none());
+
+ let mut decoder = UTF_8.new_decoder();
+ let mut output = [0u16; 4];
+ let _ = decoder.decode_to_utf16(b"\xEF", &mut output, false);
+ assert!(decoder.latin1_byte_compatible_up_to(buffer).is_none());
+ let _ = decoder.decode_to_utf16(b"\xBB\xBF", &mut output, false);
+ assert_eq!(decoder.latin1_byte_compatible_up_to(buffer), Some(1));
+ let _ = decoder.decode_to_utf16(b"\xEF", &mut output, false);
+ assert_eq!(decoder.latin1_byte_compatible_up_to(buffer), None);
+ }
+}