enrede

Crates.ioenrede
lib.rsenrede
version0.1.3
sourcesrc
created_at2024-05-25 00:10:49.977348
updated_at2024-08-09 21:13:10.417317
descriptionAn easy-to-use string encoding library, providing an interface similar to str/String.
homepage
repositoryhttps://github.com/CraftSpider/enrede
max_upload_size
id1251656
size416,527
Rune Tynan (CraftSpider)

documentation

README

Enrede

Crates.io Version Crates.io License Actions Badge

An easy-to-use string encoding library, providing an interface similar to str/String, for working with strings in encodings beyond UTF-8. Due to the API being based on std, working with other encodings is as transparent and painless as possible.

The name, enrede, is a double wordplay - Encode/Recode/Decode, and Enrede means 'tangled' or 'caught' in Spanish.

Features

  • Str<E> and String<E> types, equivalent to str and std::string::String, but generic over encoding.
  • CStr<E> and CString<E> types, equivalent to std::ffi::CStr and std::ffi::CString, but generic over encoding.
  • Encoding trait with support for lower-level direct encoding/recoding into slices
  • no_std support
  • rand::Distribution impls for encodings, allowing easy generation of valid characters for an encoding

Planned Features

These features are not yet supported, but are planned for a future version:

  • Dynamically encoded strings
  • Extended methods for encodings following certain properties:
    • Constant length encodings
  • More encodings
    • Shift-JIS
    • Big5
    • ISO/IEC 8859-1
  • More methods on strings and C-strings

no_std Support

By default, the std and alloc features are enabled. By using default-features = false in your Cargo.toml, you can disable these features. When std is disabled, this crate is no_std. When the alloc feature is disabled, the crate won't use alloc, and any types or functions requiring allocation will be disabled (For example [String<E>]).

Limitations

Currently, it is assumed that all supported encodings are subsets of the Unicode character set.

Commit count: 29

cargo fmt