1 个不稳定版本

0.3.0 2022年6月30日

#1047文本处理

Download history 51/week @ 2024-04-01 86/week @ 2024-04-08 63/week @ 2024-04-15 54/week @ 2024-04-22 23/week @ 2024-04-29 154/week @ 2024-05-06 83/week @ 2024-05-13 41/week @ 2024-05-20 113/week @ 2024-05-27 80/week @ 2024-06-03 56/week @ 2024-06-10 32/week @ 2024-06-17 29/week @ 2024-06-24 25/week @ 2024-07-01 40/week @ 2024-07-08 26/week @ 2024-07-15

每月123次下载

MIT 许可证

2MB
23K SLoC

编码

为Rust提供字符编码支持。它基于WHATWG编码标准,并提供用于错误检测和恢复的高级接口。

用法

将以下内容放入您的 Cargo.toml

[dependencies]
encoding-next = "0.3"

数据表

默认情况下,Encoding附带约480 KB的数据表("索引")。这允许Encoding有效地编码和解码旧版编码,但这可能不适合某些应用程序。

Encoding提供 no-optimized-legacy-encoding Cargo功能,以降低编码表的大小(约185 KB),但会牺牲编码性能(通常慢5倍至20倍)。解码性能保持不变。 此功能专为最终用户设计。请勿尝试从库Crates中启用此功能。

对于更精细的优化,请参阅 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 dyn RawEncoder, input: &str, output: &mut dyn 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> 以及相反的 encodedecode 方法。对于错误处理,它们分别接收 陷阱EncoderTrapDecoderTrap)来代替任何错误,例如使用一些字符串(如 U+FFFD)或序列(如 ?)。您还可以使用 EncoderTrap::StrictDecoderTrap::Strict 陷阱在错误时停止。

获取 编码 有两种方式

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

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

RawDecoder 是一个实验性的增量解码器。在每次 raw_feed 步骤中,它接收字节数组的切片,并将任何解码的字符发送到通用的 StringWriter(通常是 String)。否则,它与 RawEncoder 相同。

应该优先考虑使用 Encoding::{encode,decode} 作为主要接口。RawEncoderRawDecoder 是实验性的,可能会有重大变化。有关更多信息,请参阅 encoding::types 模块的附加文档。

支持的编码

编码涵盖了 WHATWG 编码标准中指定的所有编码以及一些其他编码

  • 7 位严格 ASCII(ascii
  • ArmSCII-8(armscii-8
  • UTF-8(utf-8
  • 小端 UTF-16(utf-16utf-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不同)
  • 代码页437(cp437

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

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

依赖关系