Iconvex Standards

iconvex_standards adds the standards, registry, and archival codecs that do not belong in Iconvex Core. Pure Elixir code implements the package. It uses no NIF, port, or system iconv process.

The OTP application installs 248 collision-reviewed byte codecs and 205 table providers. It uses one transaction. Stopping the application removes that extension. A failed or conflicting installation rolls back all changes.

Install

def deps do
  [
    {:iconvex, "~> 0.1"},
    {:iconvex_standards, "~> 0.1"}
  ]
end

Mix starts the application automatically:

{:ok, koi8} = Iconvex.convert("Привет", "UTF-8", "KOI8-F")
{:ok, "Привет"} = Iconvex.convert(koi8, "KOI8-F", "UTF-8")

{:ok, bootstring} =
  Iconvex.convert("Καλημέρα 日本語", "UTF-8", "PUNYCODE")

{:ok, "Καλημέρα 日本語"} =
  Iconvex.convert(bootstring, "PUNYCODE", "UTF-8")

{:ok, mailbox_name} =
  Iconvex.convert("旅行/日本", "UTF-8", "UTF-7-IMAP")

The package supports all standard Iconvex conversion policies. These policies include strict errors, discard, byte substitution, and Unicode substitution.

Package contents

The frozen package manifest contains:

The package contains 143 registered RFC 1345 codecs and 14 IANA PCL symbol sets. It contains 12 modern ISO-IR sets and seven CNS 11643 sets. It also contains six historical graphic sets and five mosaic or technical sets. The package also includes four Unicode legacy mappings, three JIS X 0213 sets, and two KPS 9566-97 profiles.

Notable algorithmic and source-qualified codecs include:

• PUNYCODE, UTF-7-IMAP, VIQR, MNEMONIC, and MNEM.
• All ten ISCII 1991 scripts.
• KOI7-switched, KOI8-F, draft KOI8-C, and SHORT-KOI.
• ABICOMP, BRASCII, VSCII-2, and four explicit PASCII policies.
• ECMA-1, ISO 10585, ISO-IR 42, ISO-IR 169, and fixed-width Japanese EUC.
• Three Kermit ISO profiles and three commit-qualified Lithuanian standards.
• TACE-16 in big-endian and little-endian word transports.

Iconvex.Standards.encodings/0 returns the exact registered canonical names. Iconvex.Standards.registrations/0 also exposes aliases and source provenance. SURFACE_MANIFEST.tsv provides the machine-readable ownership authority.

Odd-width transports

The byte codec API represents one six-bit or seven-bit unit per octet. Use the explicit packed facade for wire formats.

alias Iconvex.Standards.Packed

{:ok, bits} =
  Packed.encode_from_utf8("ABC", "ECMA-1-PACKED-MSB")

{:ok, "ABC"} =
  Packed.decode_to_utf8(bits, "ECMA-1-PACKED-MSB")

{:ok, lsb_transport} =
  Packed.encode_from_utf8("Привет", "SHORT-KOI-PACKED-LSB")

{:ok, "Привет"} =
  Packed.decode_to_utf8(lsb_transport, "SHORT-KOI-PACKED-LSB")

The facade returns LSB-first data as Iconvex.Packed.LSB. The value retains the exact bit length, unit width, and bit order. Do not pass :lsb with an explicitly named MSB profile. The reverse mismatch is also invalid.

Unicode property tokens

Unihan telegraph and kGB3 values are single property tokens. Therefore, they implement Iconvex.Standards.PropertyTokenMapping, not Iconvex.Codec.

alias Iconvex.Standards.Unihan17MainlandTelegraphDecimalToken, as: Telegraph

{:ok, scalar} = Telegraph.decode_token("0001")
{:ok, token} = Telegraph.encode_scalar(scalar)

Taiwan telegraph offers separate readable and lossless-VPUA reverse policies. This distinction avoids a fictitious concatenated byte-stream encoding. It also preserves duplicate and normalization-sensitive property values.

Verification

The RED/GREEN suite verifies:

• 197 migrated source tests and package-boundary tests.
• Every decode and canonical encode entry in 205 provider tables.
• All single-byte inputs and all 13,069 ISCII oracle vectors.
• Each TACE-16 word and packed source unit in both orders.
• All 7,236 kGB3 property and GL rows.
• Provider-collision rollback in lifecycle tests.

Run it locally:

ICONVEX_PATH=../iconvex mix test --warnings-as-errors
elixir tools/generate_surface_module.exs --check

The bench/ directory contains performance and scaling gates. BENCHMARKS.md describes them. TDD_LOG.md records the test chronology.

License and provenance

The original Iconvex code uses LGPL-2.1-or-later, matching GNU libiconv. Packaged upstream evidence retains its Unicode, BSD-3-Clause, MIT, or PSF terms. See NOTICE and the accompanying license files.

Complete codec catalog

The generator builds this table from the release inventories. Do not edit this section by hand. Codec names ignore ASCII letter case. You can use each alias to look up its codec. Aliases do not increase the canonical codec count.

248 canonical codecs · 396 aliases · 644 accepted names.

Registered codec names

Packed transport profiles

5 base codec profiles · 10 explicit packed names. These profiles change the bit transport only. They do not add registered Unicode mappings.