Sparkly Sandwich 🥪

This release makes some fundamental and hard changes to the API with respect to error handlers and encoding type names in the library.

• error_handler types now takes 4 parameters instead of 3. This was the addition of 1 extra parameter, which represents any prepared but unwritten characters to the output stream. More information can be found at this point in the documentation.
• encode_state/decode_state/state types are attempted to pass to the replacement_code_units/replacement_code_points/maybe_replacement_code_units/maybe_replacement_code_points functions, if at all possible. This allows for a specific state type to be properly.
• ztd::text::propagate_error is now available. This properly filters a partially-completed transcode operation (that fails at the decode_result step, for example) and pushes it through the encode part of the process with the appropriate error_handler. This function helps get the novelty and issues done right.
• The names of the counting functions have been changed (as debated in #16). Thank you to everyone who participated and made it happen!
• All the names of encoding types (utf8, utf16, etc.) are now objects, and their types are now suffixed with _t. This is becase 99.9% of the time, one just wants to use the encoding object, not create a new instance every single time they use it (thanks for the push here @hanickadot !)

The documentation has been vastly improved in many places, as well, to make it easier to find out specific kinds of information. It still needs more work, but that's why this isn't a v1.0.0 library yet!

Go forth, and text to your heart's delight!

💚, ThePhD & Shepherd's Oasis

Zero Standard - Text Library

🎉 This is the first release for ztd.text !~

The API and expectations are fully documented over at the documentation page, here: https://ztdtext.rtfd.io.

We wanted to try something different when we first released this library, so we focused on fully documenting all of the public-facing APIs and writing full design docs the first go-around, rather than leaving a hodgepodge of use cases and buildup for everyone to see. We've found this approach to be helpful in making sure that nothing in the library goes undone, and we hope to write about it and talk about that process soon!

The examples, benchmarks, and "Getting Started" are not completely filled out yet. There are still some examples in the examples directory, though, and we encourage you to peek at them, even if they are quite sparse!

We're quite proud of Version 0, and we hope to release even better versions, soon.

Thanks, Shepherd's Oasis & ThePhD