编码 0.3.0-dev

为 Rust 提供字符编码支持。（也称为 rust-encoding）它基于 WHATWG 编码标准，并提供了高级的错误检测和恢复接口。

此文档适用于开发版本（0.3）。请参阅 0.2.x 版本的 稳定文档。

完整文档（稳定版）

用法

将此内容放入您的 Cargo.toml

[dependencies]
encoding = "0.3"

然后将此内容放入您的 crate 根目录

extern crate encoding;

数据表

默认情况下，Encoding 随附约 480 KB 的数据表（"索引"）。这允许 Encoding 高效地编码和解码旧编码，但对于某些应用程序可能不希望如此。

Encoding 提供了 no-optimized-legacy-encoding Cargo 功能来减小编码表的大小（约 185 KB），但会以编码性能为代价（通常慢 5 倍到 20 倍）。解码性能保持不变。 此功能强烈建议用于最终用户。请勿从库 crate 中启用此功能。

有关更精细的优化，请参阅 src/index/gen_index.py 以生成自定义表。

概述

要编码字符串

use encoding::{Encoding, EncoderTrap};
use encoding::all::ISO_8859_1;

assert_eq!(ISO_8859_1.encode("caf\u{e9}", EncoderTrap::Strict),
           Ok(vec![99,97,102,233]));

要编码包含不可表示字符的字符串

use encoding::{Encoding, EncoderTrap};
use encoding::all::ISO_8859_2;

assert!(ISO_8859_2.encode("Acme\u{a9}", EncoderTrap::Strict).is_err());
assert_eq!(ISO_8859_2.encode("Acme\u{a9}", EncoderTrap::Replace),
           Ok(vec![65,99,109,101,63]));
assert_eq!(ISO_8859_2.encode("Acme\u{a9}", EncoderTrap::Ignore),
           Ok(vec![65,99,109,101]));
assert_eq!(ISO_8859_2.encode("Acme\u{a9}", EncoderTrap::NcrEscape),
           Ok(vec![65,99,109,101,38,35,49,54,57,59]));

要解码字节序列

use encoding::{Encoding, DecoderTrap};
use encoding::all::ISO_8859_1;

assert_eq!(ISO_8859_1.decode(&[99,97,102,233], DecoderTrap::Strict),
           Ok("caf\u{e9}".to_string()));

要解码包含无效序列的字节序列

use encoding::{Encoding, DecoderTrap};
use encoding::all::ISO_8859_6;

assert!(ISO_8859_6.decode(&[65,99,109,101,169], DecoderTrap::Strict).is_err());
assert_eq!(ISO_8859_6.decode(&[65,99,109,101,169], DecoderTrap::Replace),
           Ok("Acme\u{fffd}".to_string()));
assert_eq!(ISO_8859_6.decode(&[65,99,109,101,169], DecoderTrap::Ignore),
           Ok("Acme".to_string()));

要将输入编码或解码到已分配的缓冲区中

use encoding::{Encoding, EncoderTrap, DecoderTrap};
use encoding::all::{ISO_8859_2, ISO_8859_6};

let mut bytes = Vec::new();
let mut chars = String::new();

assert!(ISO_8859_2.encode_to("Acme\u{a9}", EncoderTrap::Ignore, &mut bytes).is_ok());
assert!(ISO_8859_6.decode_to(&[65,99,109,101,169], DecoderTrap::Replace, &mut chars).is_ok());

assert_eq!(bytes, [65,99,109,101]);
assert_eq!(chars, "Acme\u{fffd}");

自定义编码器陷阱的实际示例

use encoding::{Encoding, ByteWriter, EncoderTrap, DecoderTrap};
use encoding::types::RawEncoder;
use encoding::all::ASCII;

// hexadecimal numeric character reference replacement
fn hex_ncr_escape(_encoder: &mut RawEncoder, input: &str, output: &mut ByteWriter) -> bool {
    let escapes: Vec<String> =
        input.chars().map(|ch| format!("&#x{:x};", ch as isize)).collect();
    let escapes = escapes.concat();
    output.write_bytes(escapes.as_bytes());
    true
}
static HEX_NCR_ESCAPE: EncoderTrap = EncoderTrap::Call(hex_ncr_escape);

let orig = "Hello, 世界!".to_string();
let encoded = ASCII.encode(&orig, HEX_NCR_ESCAPE).unwrap();
assert_eq!(ASCII.decode(&encoded, DecoderTrap::Strict),
           Ok("Hello, &#x4e16;&#x754c;!".to_string()));

从字符串标签获取编码，如 WHATWG 编码标准所述

use encoding::{Encoding, DecoderTrap};
use encoding::label::encoding_from_whatwg_label;
use encoding::all::WINDOWS_949;

let euckr = encoding_from_whatwg_label("euc-kr").unwrap();
assert_eq!(euckr.name(), "windows-949");
assert_eq!(euckr.whatwg_name(), Some("euc-kr")); // for the sake of compatibility
let broken = &[0xbf, 0xec, 0xbf, 0xcd, 0xff, 0xbe, 0xd3];
assert_eq!(euckr.decode(broken, DecoderTrap::Replace),
           Ok("\u{c6b0}\u{c640}\u{fffd}\u{c559}".to_string()));

// corresponding Encoding native API:
assert_eq!(WINDOWS_949.decode(broken, DecoderTrap::Replace),
           Ok("\u{c6b0}\u{c640}\u{fffd}\u{c559}".to_string()));

类型和内容

Encoding 有三个主要入口点。

编码 是一种单字符编码。它包含用于将 String 转换为 Vec<u8> 及其相反过程的 encode 和 decode 方法。对于错误处理，它们分别接收 陷阱 (EncoderTrap 和 DecoderTrap)，这些陷阱将任何错误替换为某些字符串（例如 U+FFFD）或序列（例如 ?）。您还可以使用 EncoderTrap::Strict 和 DecoderTrap::Strict 陷阱在错误发生时停止。

获取 编码 有两种方式

• encoding::all 为每个支持的编码提供了静态项。当编码不会改变或只需要少数几个时，应使用它们。与链接时间优化相结合，任何未使用的编码都将从二进制文件中删除。
• encoding::label 提供了从给定字符串（“标签”）动态获取编码的函数。它们将返回对编码的静态引用，其类型也称为 EncodingRef。当预先无法获取所需编码列表时，这很有用，但它会导致二进制文件更大，并错过优化机会。

RawEncoder 是一个实验性的增量编码器。在 raw_feed 的每个步骤中，它接收字符串的切片，并将任何编码的字节输出到通用的 ByteWriter（通常是 Vec<u8>）。如果发生任何错误，它将在第一次停止，并返回包含 CodecError 结构的 CodecError。调用者负责在编码过程结束时调用 raw_finish。

RawDecoder 是一个实验性的增量解码器。在 raw_feed 的每个步骤中，它接收字节序列的切片，并将任何解码的字符输出到通用的 StringWriter（通常是 String）。否则它与 RawEncoder 相同。

应首选 Encoding::{encode,decode} 作为主要接口。 RawEncoder 和 RawDecoder 是实验性的，可能会发生重大变化。有关更多信息，请参阅 encoding::types 模块中的附加文档。

支持的编码

编码涵盖了 WHATWG 编码标准中指定的所有编码以及更多

• 7 位严格 ASCII（《ascii》）
• UTF-8（《utf-8》）
• 小端 UTF-16（《utf-16》或《utf-16le》）和大端 UTF-16（《utf-16be》）
• WHATWG 编码标准中所有的单字节编码
  • IBM 代码页 866
  • ISO 8859-{2,3,4,5,6,7,8,10,13,14,15,16}
  • KOI8-R, KOI8-U
  • MacRoman（《macintosh》），Macintosh 西里尔编码（《x-mac-cyrillic》）
  • Windows代码页874、1250、1251、1252（代替ISO 8859-1）、1253、1254（代替ISO 8859-9）、1255、1256、1257、1258
• WHATWG编码标准中所有的多字节编码
  • Windows代码页949（euc-kr，因为严格的EUC-KR几乎不使用）
  • EUC-JP和Windows代码页932（shift_jis，因为它是Shift_JIS最广泛的扩展）
  • ISO-2022-JP带有非对称JIS X 0212支持（注意：这尚未符合当前标准）
  • GBK
  • GB 18030
  • Big5-2003带有HKSCS-2008扩展
• 最初由WHATWG编码标准指定的编码
  • HZ
• ISO 8859-1（与Windows代码页1252不同）

括号内的名称是指由WHATWG编码标准指定的编码的主要名称。

许多传统的字符编码缺乏适当的规范，甚至那些有规范的也高度依赖于实际实现。因此，在选择所需的字符编码时应谨慎。在这个方面唯一可靠的规范是WHATWG编码标准和Unicode联盟提供的供应商映射。如有疑问，请查看源代码和规范以获取详细说明。