Crate data_encoding_v3

Source
Expand description

Efficient and customizable data-encoding functions like base64, base32, and hex :warning: It is strongly discouraged to use this crate at this time. There are no guarantees whatsoever (correctness, stability, documentation, etc). This warning will be updated as new versions are published.

This crate is the development branch of data-encoding@3.0.0. It is provided as a workaround to the Cargo pre-release issues. It will obey the following rules:

  • The initial version is data-encoding-v3@0.1.0
  • The final version is data-encoding-v3@1.0.0
  • Version data-encoding-v3@0.x.y represents data-encoding@3.0.0-x.y
  • Version data-encoding-v3@1.0.0 corresponds to data-encoding@3.0.0
  • Only the final version will be published to data-encoding

In particular, the data-encoding crate won’t have any 3.0.0 pre-release version. This crate should be used instead. To minimize code changes (v3 won’t break simple usages of v2), you can modify your Cargo.toml from using data-encoding:

[dependencies]
data-encoding = "2.9.0"

to using data-encoding-v3 while preserving the crate name:

[dependencies]
data-encoding = { package = "data-encoding-v3", version = "0.1.0" }

When data-encoding-v3 reaches 1.0.0, then data-encoding will reach 3.0.0 too, and the Cargo.toml should use data-encoding again:

[dependencies]
data-encoding = "3.0.0"

Structs§

DecodeError
Decoding error
DecodePartial
Decoding error with partial result
DynEncoding
Base-conversion encoding
Encoding
Base-conversion encoding.
Specificationalloc
Base-conversion specification
SpecificationErroralloc
Specification error
Translatealloc
How to translate characters when decoding
Wrapalloc
How to wrap the output when encoding

Enums§

Bit1
Bit-width of base2 encodings.
Bit2
Bit-width of base4 encodings.
Bit3
Bit-width of base8 encodings.
Bit4
Bit-width of base16 encodings.
Bit5
Bit-width of base32 encodings.
Bit6
Bit-width of base64 encodings.
BitOrderalloc
Order in which bits are read from a byte
ConvertError
Error converting from a dynamic encoding to a static one.
DecodeKind
Decoding error kind
False
Type-level false.
True
Type-level true.

Statics§

BASE32
Padded base32 encoding
BASE64
Padded base64 encoding
BASE32HEX
Padded base32hex encoding
BASE32HEX_NOPAD
Unpadded base32hex encoding
BASE32_DNSCURVE
DNSCurve base32 encoding
BASE32_DNSSEC
DNSSEC base32 encoding
BASE32_NOPAD
Unpadded base32 encoding
BASE64URL
Padded base64url encoding
BASE64URL_NOPAD
Unpadded base64url encoding
BASE64_MIME
MIME base64 encoding
BASE64_MIME_PERMISSIVE
MIME base64 encoding without trailing bits check
BASE64_NOPAD
Unpadded base64 encoding
HEXLOWER
Lowercase hexadecimal encoding
HEXLOWER_PERMISSIVE
Lowercase hexadecimal encoding with case-insensitive decoding
HEXUPPER
Uppercase hexadecimal encoding
HEXUPPER_PERMISSIVE
Uppercase hexadecimal encoding with case-insensitive decoding

Traits§

BitWidth
Type-level bit-width of an encoding.
Bool
Type-level bool.

Type Aliases§

Base32
Base32 encoding.
Base64
Base64 encoding.
Base32LsbNoPad
Base32 encoding (LSB first, no padding).
Base32NoPad
Base32 encoding (no padding).
Base64NoPad
Base64 encoding (no padding).
Base64Wrap
Base64 encoding (wrap).
Hex
Hexadecimal encoding.