.. =============================================================================
..
.. ztd.text
.. Copyright © JeanHeyd "ThePhD" Meneide and Shepherd's Oasis, LLC
.. Contact: opensource@soasis.org
..
.. Commercial License Usage
.. Licensees holding valid commercial ztd.text licenses may use this file in
.. accordance with the commercial license agreement provided with the
.. Software or, alternatively, in accordance with the terms contained in
.. a written agreement between you and Shepherd's Oasis, LLC.
.. For licensing terms and conditions see your agreement. For
.. further information contact opensource@soasis.org.
..
.. Apache License Version 2 Usage
.. Alternatively, this file may be used under the terms of Apache License
.. Version 2.0 (the "License") for non-commercial use; you may not use this
.. file except in compliance with the License. You may obtain a copy of the
.. License at
..
.. https://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
..
.. =============================================================================>

Encoding Scheme
===============

The ``encoding_scheme`` template turns any encoding into a byte-based encoding capable of reading and writing those bytes into and out of byte-\ ``value_type`` ranges. It prevents duplicating effort to read encodings as little endian or big endian, allowing composition for any desired encoding to interface with e.g. a UTF-16 Big Endian blob of data coming over a network or shared pipe.



Aliases
-------

.. doxygentypedef:: ztd::text::basic_utf16_le

.. doxygentypedef:: ztd::text::utf16_le_t

.. doxygentypedef:: ztd::text::basic_utf16_be

.. doxygentypedef:: ztd::text::utf16_be_t

.. doxygentypedef:: ztd::text::basic_utf16_ne

.. doxygentypedef:: ztd::text::utf16_ne_t

.. doxygentypedef:: ztd::text::basic_utf32_le

.. doxygentypedef:: ztd::text::utf32_le_t

.. doxygentypedef:: ztd::text::basic_utf32_be

.. doxygentypedef:: ztd::text::utf32_be_t

.. doxygentypedef:: ztd::text::basic_utf32_ne

.. doxygentypedef:: ztd::text::utf32_ne_t



Base Template
-------------

.. doxygengroup:: ztd_text_encoding_scheme
	:content-only: