Unicode Encodings

Group related to unicode encodings (including UTF8, UTF16, UTF32 ane endianness) More...

Classes
struct	mtcore::EndianSlice< T, Endian >
	A Slice with Endian-aware data which is just a pointer + length + endian direction Accessing elements through the array operator will do bounds checks and will convert to native endian by default (this can be overridden with access methods) Accessing out of bounds will terminate the program instead of throw Can also get sub slices. More...
struct	mtcore::RuneIterator< char16_t >
	Iterates over runes of utf16 sequences Also handles flipping endianness to native endian. More...

Typedefs
using	mtcore::SliceU16Native = EndianSlice<char16_t, std::endian::native>
	Slice type representing native UTF-16 string *.
using	mtcore::SliceU16Le = EndianSlice<char16_t, std::endian::little>
	Slice type representing little endian UTF-16 string *.
using	mtcore::SliceU16Be = EndianSlice<char16_t, std::endian::big>
	Slice type representing big endian UTF-16 string *.
using	mtcore::SliceConstU16Native = EndianSlice<const char16_t, std::endian::native>
	Slice type representing const native UTF-16 string *.
using	mtcore::SliceConstU16Le = EndianSlice<const char16_t, std::endian::little>
	Slice type representing const little endian UTF-16 string *.
using	mtcore::SliceConstU16Be = EndianSlice<const char16_t, std::endian::big>
	Slice type representing const big endian UTF-16 string *.
using	mtcore::SliceU32Native = EndianSlice<char32_t, std::endian::native>
	Slice type representing native UTF-32 string *.
using	mtcore::SliceU32Le = EndianSlice<char32_t, std::endian::little>
	Slice type representing little endian UTF-32 string *.
using	mtcore::SliceU32Be = EndianSlice<char32_t, std::endian::big>
	Slice type representing big endian UTF-32 string.
using	mtcore::SliceConstU32Native = EndianSlice<const char32_t, std::endian::native>
	Slice type representing const native UTF-32 string.
using	mtcore::SliceConstU32Le = EndianSlice<const char32_t, std::endian::little>
	Slice type representing const little endian UTF-32 string.
using	mtcore::SliceConstU32Be = EndianSlice<const char32_t, std::endian::big>
	Slice type representing const big endian UTF-32 string.

Functions
constexpr auto	mtcore::is_bom (const char32_t ch)
	Checks if a character is a BOM in native ordering.
constexpr auto	mtcore::is_bom_rev_16_bit (const char16_t ch)
	Checks if a 16-bit character is a BOM in reverse ordering.
constexpr auto	mtcore::is_bom_rev_32_bit (const char32_t ch)
	Checks if a 32-bit character is a BOM in reverse ordering.
Optional< std::endian >	mtcore::u16_detect_endian (const char16_t ch)
	Tries to detect the endian encoding based on a possible BOM mark.
Optional< std::endian >	mtcore::u32_detect_endian (const char32_t ch)
	Tries to detect the endian encoding based on a possible BOM mark.
constexpr bool	mtcore::is_surrogate (char16_t ch)
	Checks if UTF-16 character is a surrogate.
constexpr bool	mtcore::is_high_surrogate (char16_t ch)
	Checks if UTF-16 character is a high surrogate *.
constexpr bool	mtcore::is_low_surrogate (char16_t ch)
	Checks if UTF-16 character is a low surrogate *.
SliceU16Native	mtcore::endian_from_native_slice (Slice< char16_t > s)
	Gets a UTF-16 endian slice from a slice which is assumed ot be native endian.
SliceU32Native	mtcore::endian_from_native_slice (Slice< char32_t > s)
	Gets a UTF-32 endian slice from a slice which is assumed ot be native endian.
SliceU16Le	mtcore::endian_from_le_slice (Slice< char16_t > s)
	Gets a UTF-16 endian slice from a slice which is assumed ot be little endian.
SliceU32Le	mtcore::endian_from_le_slice (Slice< char32_t > s)
	Gets a UTF-32 endian slice from a slice which is assumed ot be little endian.
SliceU16Be	mtcore::endian_from_be_slice (Slice< char16_t > s)
	Gets a UTF-16 endian slice from a slice which is assumed ot be big endian.
SliceU32Be	mtcore::endian_from_be_slice (Slice< char32_t > s)
	Gets a UTF-32 endian slice from a slice which is assumed ot be big endian.
std::variant< SliceU16Le, SliceU16Be >	mtcore::endian_from_slice (Slice< char16_t > s)
	Gets a UTF-16 endian slice from an input slice Will try to use the first character of the slice as a BOM to detect endianness If endian detection fails, will assume native endian Since endian slices are distinct types, this will return a variant (typed union) If there is a BOM, will drop it.
std::variant< SliceU32Le, SliceU32Be >	mtcore::endian_from_slice (Slice< char32_t > s)
	Gets a UTF-32 endian slice from an input slice Will try to use the first character of the slice as a BOM to detect endianness If endian detection fails, will assume native endian Since endian slices are distinct types, this will return a variant (typed union) If there is a BOM, will drop it.
Slice< char16_t >	mtcore::slice_from_native_endian (SliceU16Native s)
	Gets a normal slice from a native endian slice.
Slice< const char16_t >	mtcore::slice_from_native_endian (SliceConstU16Native s)
	Gets a normal slice from a native endian slice.
Slice< char32_t >	mtcore::slice_from_native_endian (SliceU32Native s)
	Gets a normal slice from a native endian slice.
Slice< const char32_t >	mtcore::slice_from_native_endian (SliceConstU32Native s)
	Gets a normal slice from a native endian slice.
Slice< char16_t >	mtcore::slice_from_le_endian (SliceU16Native s)
	Gets a normal slice from a little endian slice.
Slice< const char16_t >	mtcore::slice_from_le_endian (SliceConstU16Native s)
	Gets a normal slice from a little endian slice.
Slice< char32_t >	mtcore::slice_from_le_endian (SliceU32Native s)
	Gets a normal slice from a little endian slice.
Slice< const char32_t >	mtcore::slice_from_le_endian (SliceConstU32Native s)
	Gets a normal slice from a little endian slice.
Slice< char16_t >	mtcore::slice_from_be_endian (SliceU16Native s)
	Gets a normal slice from a big endian slice.
Slice< const char16_t >	mtcore::slice_from_be_endian (SliceConstU16Native s)
	Gets a normal slice from a big endian slice.
Slice< char32_t >	mtcore::slice_from_be_endian (SliceU32Native s)
	Gets a normal slice from a big endian slice.
Slice< const char32_t >	mtcore::slice_from_be_endian (SliceConstU32Native s)
	Gets a normal slice from a big endian slice.
CharSeq	mtcore::rune_to_str (Rune rune)
	Converts a UTF-32 Rune to a sequence of char.
U8Seq	mtcore::rune_to_utf8 (Rune rune)
	Converts a UTF-32 Rune to a utf-8 sequence.
U16Seq	mtcore::rune_to_utf16 (Rune rune)
	Converts a UTF-32 Rune to a utf-16 sequence.
RuneIterator< char >	mtcore::str_rune_iterator (const Slice< const char > &s)
	Rune iterator for a slice of characters.
RuneIterator< char8_t >	mtcore::utf8_rune_iterator (const Slice< const char8_t > &s)
	Rune iterator for a UTF8 sequence.
RuneIterator< char16_t >	mtcore::utf16_rune_iterator (const Slice< const char16_t > &s)
	Rune iterator for a UTF16 sequence.
RuneIterator< char16_t >	mtcore::utf16_rune_iterator (const SliceConstU16Le &s)
	Rune iterator for a little endian UTF16 sequence.
RuneIterator< char16_t >	mtcore::utf16_rune_iterator (const SliceConstU16Be &s)
	Rune iterator for a big endian UTF16 sequence.
RuneIterator< char16_t >	mtcore::utf16_rune_iterator (const SliceU16Le &s)
	Rune iterator for a little endian UTF16 sequence.
RuneIterator< char16_t >	mtcore::utf16_rune_iterator (const SliceU16Be &s)
	Rune iterator for a big endian UTF16 sequence.
RuneIterator< char32_t >	mtcore::utf32_rune_iterator (const Slice< const char32_t > &s)
	Rune iterator for a UTF32 sequence.
RuneIterator< char32_t >	mtcore::utf32_rune_iterator (const SliceConstU32Le &s)
	Rune iterator for a little endian UTF32 sequence.
RuneIterator< char32_t >	mtcore::utf32_rune_iterator (const SliceConstU32Be &s)
	Rune iterator for a big endian UTF32 sequence.
RuneIterator< char32_t >	mtcore::utf32_rune_iterator (const SliceU32Le &s)
	Rune iterator for a little endian UTF32 sequence.
RuneIterator< char32_t >	mtcore::utf32_rune_iterator (const SliceU32Be &s)
	Rune iterator for a big endian UTF32 sequence.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf16 (io::Writer< WI > &writer, const SliceConstU32Be &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to UTF-16 string Can optionally write a BOM to the prefix.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf16 (io::Writer< WI > &writer, const SliceConstU32Le &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to UTF-16 string Can optionally write a BOM to the prefix.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf16 (io::Writer< WI > &writer, const Slice< const char32_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to UTF-16 string Can optionally write a BOM to the prefix.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf8 (io::Writer< WI > &writer, const SliceConstU32Be &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to UTF-8 string.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf8 (io::Writer< WI > &writer, const SliceConstU32Le &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to UTF-8 string.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf8 (io::Writer< WI > &writer, const Slice< const char32_t > &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to UTF-8 string.
template<WriterImpl WI>
auto	mtcore::utf32_to_str (io::Writer< WI > &writer, const SliceConstU32Be &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to character sequence (UTF-8 encoded chars)
template<WriterImpl WI>
auto	mtcore::utf32_to_str (io::Writer< WI > &writer, const SliceConstU32Le &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to character sequence (UTF-8 encoded chars)
template<WriterImpl WI>
auto	mtcore::utf32_to_str (io::Writer< WI > &writer, const Slice< const char32_t > &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-32 string to character sequence (UTF-8 encoded chars)
template<WriterImpl WI>
auto	mtcore::utf8_to_utf32 (io::Writer< WI > &writer, const Slice< const char8_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-8 string to UTF-32.
template<WriterImpl WI>
auto	mtcore::str_to_utf32 (io::Writer< WI > &writer, const Slice< const char > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-8 string to UTF-32.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf8 (io::Writer< WI > &writer, const SliceConstU16Be &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-8.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf32 (io::Writer< WI > &writer, const SliceConstU16Le &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-32.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf32 (io::Writer< WI > &writer, const SliceConstU16Be &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-32.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf32 (io::Writer< WI > &writer, const Slice< const char16_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-32.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf8 (io::Writer< WI > &writer, const SliceConstU16Le &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-8.
template<WriterImpl WI>
auto	mtcore::utf16_to_str (io::Writer< WI > &writer, const SliceConstU16Be &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-8.
template<WriterImpl WI>
auto	mtcore::utf16_to_str (io::Writer< WI > &writer, const SliceConstU16Le &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-8.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf8 (io::Writer< WI > &writer, const Slice< const char16_t > &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-8.
template<WriterImpl WI>
auto	mtcore::utf16_to_str (io::Writer< WI > &writer, const Slice< const char16_t > &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-16 string to UTF-8.
template<WriterImpl WI>
auto	mtcore::utf8_to_utf16 (io::Writer< WI > &writer, const Slice< const char8_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-8 string to UTF-16.
template<WriterImpl WI>
auto	mtcore::str_to_utf16 (io::Writer< WI > &writer, const Slice< const char > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-8 string to UTF-16.
template<WriterImpl WI>
auto	mtcore::utf8_to_str (io::Writer< WI > &writer, const Slice< const char8_t > &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a UTF-8 string to character sequence.
template<WriterImpl WI>
auto	mtcore::str_to_utf8 (io::Writer< WI > &writer, const Slice< const char > &str) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Will convert a character sequence to UTF-8 string.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf16le (io::Writer< WI > &writer, const SliceConstU16Native &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts native UTF-16 to UTF-16 Little Endian.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf16le (io::Writer< WI > &writer, const Slice< const char16_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts native UTF-16 to UTF-16 Little Endian.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf16be (io::Writer< WI > &writer, const SliceConstU16Native &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts native UTF-16 to UTF-16 Big Endian.
template<WriterImpl WI>
auto	mtcore::utf16_to_utf16be (io::Writer< WI > &writer, const Slice< const char16_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts native UTF-16 to UTF-16 Big Endian.
template<WriterImpl WI>
auto	mtcore::utf16le_to_utf16be (io::Writer< WI > &writer, const SliceConstU16Le &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-16 Little Endian to UTF-16 Big Endian.
template<WriterImpl WI>
auto	mtcore::utf16be_to_utf16le (io::Writer< WI > &writer, const SliceConstU16Be &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-16 Big Endian to UTF-16 Little Endian.
template<WriterImpl WI>
auto	mtcore::utf16le_to_utf16 (io::Writer< WI > &writer, const SliceConstU16Le &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-16 Little Endian to Native UTF-16.
template<WriterImpl WI>
auto	mtcore::utf16be_to_utf16 (io::Writer< WI > &writer, const SliceConstU16Be &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-16 Big Endian to Native UTF-16.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf32le (io::Writer< WI > &writer, const SliceConstU32Native &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Native Endian to UTF-32 Little Endian.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf32le (io::Writer< WI > &writer, const Slice< const char32_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Native Endian to UTF-32 Little Endian.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf32be (io::Writer< WI > &writer, const SliceConstU32Native &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Native Endian to UTF-32 Big Endian.
template<WriterImpl WI>
auto	mtcore::utf32_to_utf32be (io::Writer< WI > &writer, const Slice< const char32_t > &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Native Endian to UTF-32 Big Endian.
template<WriterImpl WI>
auto	mtcore::utf32le_to_utf32be (io::Writer< WI > &writer, const SliceConstU32Le &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Little Endian to UTF-32 Big Endian.
template<WriterImpl WI>
auto	mtcore::utf32be_to_utf32le (io::Writer< WI > &writer, const SliceConstU32Be &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Big Endian to UTF-32 Little Endian.
template<WriterImpl WI>
auto	mtcore::utf32le_to_utf32 (io::Writer< WI > &writer, const SliceConstU32Le &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Little Endian to UTF-32 Native Endian.
template<WriterImpl WI>
auto	mtcore::utf32be_to_utf32 (io::Writer< WI > &writer, const SliceConstU32Be &str, bool writeBom=false) -> Result< size_t, typename io::Writer< WI >::ErrType >
	Converts UTF-32 Big Endian to UTF-32 Native Endian.

Variables
constexpr char32_t	mtcore::bom = 0xFEFF
	Native representation of Byte Order Mark (BOM)
template<std::endian E = std::endian::native>
constexpr auto	mtcore::oppositeEndian = E == std::endian::big ? std::endian::little : std::endian::big
	Returns the opposite endianness of a given endian (default is opposite of the native endian)

Detailed Description

Group related to unicode encodings (including UTF8, UTF16, UTF32 ane endianness)

Typedef Documentation

SliceConstU16Be

using mtcore::SliceConstU16Be = EndianSlice<const char16_t, std::endian::big>

Slice type representing const big endian UTF-16 string *.

Definition at line 523 of file byte_endian.hpp.

SliceConstU16Le

using mtcore::SliceConstU16Le = EndianSlice<const char16_t, std::endian::little>

Slice type representing const little endian UTF-16 string *.

Definition at line 519 of file byte_endian.hpp.

SliceConstU16Native

using mtcore::SliceConstU16Native = EndianSlice<const char16_t, std::endian::native>

Slice type representing const native UTF-16 string *.

Definition at line 515 of file byte_endian.hpp.

SliceConstU32Be

using mtcore::SliceConstU32Be = EndianSlice<const char32_t, std::endian::big>

Slice type representing const big endian UTF-32 string.

Definition at line 552 of file byte_endian.hpp.

SliceConstU32Le

using mtcore::SliceConstU32Le = EndianSlice<const char32_t, std::endian::little>

Slice type representing const little endian UTF-32 string.

Definition at line 547 of file byte_endian.hpp.

SliceConstU32Native

using mtcore::SliceConstU32Native = EndianSlice<const char32_t, std::endian::native>

Slice type representing const native UTF-32 string.

Definition at line 542 of file byte_endian.hpp.

SliceU16Be

using mtcore::SliceU16Be = EndianSlice<char16_t, std::endian::big>

Slice type representing big endian UTF-16 string *.

Definition at line 511 of file byte_endian.hpp.

SliceU16Le

using mtcore::SliceU16Le = EndianSlice<char16_t, std::endian::little>

Slice type representing little endian UTF-16 string *.

Definition at line 507 of file byte_endian.hpp.

SliceU16Native

using mtcore::SliceU16Native = EndianSlice<char16_t, std::endian::native>

Slice type representing native UTF-16 string *.

Definition at line 503 of file byte_endian.hpp.

SliceU32Be

using mtcore::SliceU32Be = EndianSlice<char32_t, std::endian::big>

Slice type representing big endian UTF-32 string.

Definition at line 537 of file byte_endian.hpp.

SliceU32Le

using mtcore::SliceU32Le = EndianSlice<char32_t, std::endian::little>

Slice type representing little endian UTF-32 string *.

Definition at line 532 of file byte_endian.hpp.

SliceU32Native

using mtcore::SliceU32Native = EndianSlice<char32_t, std::endian::native>

Slice type representing native UTF-32 string *.

Definition at line 528 of file byte_endian.hpp.

Function Documentation

endian_from_be_slice() [1/2]

SliceConstU16Be mtcore::endian_from_be_slice ( Slice< char16_t > s )

inline

Gets a UTF-16 endian slice from a slice which is assumed ot be big endian.

Gets a const UTF-16 endian slice from a slice which is assumed ot be big endian ingroup unicode_enc.

Definition at line 580 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

endian_from_be_slice() [2/2]

SliceConstU32Be mtcore::endian_from_be_slice ( Slice< char32_t > s )

inline

Gets a UTF-32 endian slice from a slice which is assumed ot be big endian.

Gets a const UTF-32 endian slice from a slice which is assumed ot be big endian ingroup unicode_enc.

Definition at line 585 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

endian_from_le_slice() [1/2]

SliceConstU16Le mtcore::endian_from_le_slice ( Slice< char16_t > s )

inline

Gets a UTF-16 endian slice from a slice which is assumed ot be little endian.

Gets a const UTF-16 endian slice from a slice which is assumed ot be little endian.

Definition at line 569 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

endian_from_le_slice() [2/2]

SliceConstU32Le mtcore::endian_from_le_slice ( Slice< char32_t > s )

inline

Gets a UTF-32 endian slice from a slice which is assumed ot be little endian.

Gets a const UTF-32 endian slice from a slice which is assumed ot be little endian.

Definition at line 574 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

endian_from_native_slice() [1/2]

SliceConstU16Native mtcore::endian_from_native_slice ( Slice< char16_t > s )

inline

Gets a UTF-16 endian slice from a slice which is assumed ot be native endian.

Gets a const UTF-16 endian slice from a slice which is assumed ot be native endian.

Definition at line 558 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

Here is the caller graph for this function:

endian_from_native_slice() [2/2]

SliceConstU32Native mtcore::endian_from_native_slice ( Slice< char32_t > s )

inline

Gets a UTF-32 endian slice from a slice which is assumed ot be native endian.

Definition at line 563 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

endian_from_slice() [1/2]

std::variant< SliceConstU16Le, SliceConstU16Be > mtcore::endian_from_slice ( Slice< char16_t > s )

inline

Gets a UTF-16 endian slice from an input slice Will try to use the first character of the slice as a BOM to detect endianness If endian detection fails, will assume native endian Since endian slices are distinct types, this will return a variant (typed union) If there is a BOM, will drop it.

Gets a const UTF-16 endian slice from an input slice Will try to use the first character of the slice as a BOM to detect endianness If endian detection fails, will assume native endian Since endian slices are distinct types, this will return a variant (typed union) If there is a BOM, will drop it.

Definition at line 632 of file byte_endian.hpp.

                                                                                 {
    if (s.size() > 0) {
      if (auto detect = u16_detect_endian(s[0]); detect.has_value()) {
        auto subbed = s.sub(1);
        if (detect.value() == std::endian::little) {
          return SliceU16Le{.head = subbed.head, .len = subbed.len};
        }
        else {
          return SliceU16Be{.head = subbed.head, .len = subbed.len};
        }
      }
    }
    return SliceU16Native{.head = s.head, .len = s.len};
  }

Here is the call graph for this function:

endian_from_slice() [2/2]

std::variant< SliceConstU32Le, SliceConstU32Be > mtcore::endian_from_slice ( Slice< char32_t > s )

inline

Gets a UTF-32 endian slice from an input slice Will try to use the first character of the slice as a BOM to detect endianness If endian detection fails, will assume native endian Since endian slices are distinct types, this will return a variant (typed union) If there is a BOM, will drop it.

Gets a const UTF-32 endian slice from an input slice Will try to use the first character of the slice as a BOM to detect endianness If endian detection fails, will assume native endian Since endian slices are distinct types, this will return a variant (typed union) If there is a BOM, will drop it.

Definition at line 655 of file byte_endian.hpp.

                                                                                 {
    if (s.size() > 0) {
      if (auto detect = u16_detect_endian(s[0]); detect.has_value()) {
        auto subbed = s.sub(1);
        if (detect.value() == std::endian::little) {
          return SliceU32Le{.head = subbed.head, .len = subbed.len};
        }
        else {
          return SliceU32Be{.head = subbed.head, .len = subbed.len};
        }
      }
    }
    return SliceU32Native{.head = s.head, .len = s.len};
  }

Here is the call graph for this function:

is_bom()

auto mtcore::is_bom ( const char32_t ch )

constexpr

Checks if a character is a BOM in native ordering.

Definition at line 45 of file byte_endian.hpp.

{ return ch == bom; }

Here is the caller graph for this function:

is_bom_rev_16_bit()

auto mtcore::is_bom_rev_16_bit ( const char16_t ch )

constexpr

Checks if a 16-bit character is a BOM in reverse ordering.

Definition at line 50 of file byte_endian.hpp.

{ return ch == 0xFFFE; }

Here is the caller graph for this function:

is_bom_rev_32_bit()

auto mtcore::is_bom_rev_32_bit ( const char32_t ch )

constexpr

Checks if a 32-bit character is a BOM in reverse ordering.

Definition at line 55 of file byte_endian.hpp.

{ return ch == 0xFFFE0000; }

Here is the caller graph for this function:

is_high_surrogate()

bool mtcore::is_high_surrogate ( char16_t ch )

constexpr

Checks if UTF-16 character is a high surrogate *.

Definition at line 147 of file byte_endian.hpp.

{ return ch >= 0xD800 && ch <= 0xDBFF; }

Here is the caller graph for this function:

is_low_surrogate()

bool mtcore::is_low_surrogate ( char16_t ch )

constexpr

Checks if UTF-16 character is a low surrogate *.

Definition at line 151 of file byte_endian.hpp.

{ return ch >= 0xDC00 && ch <= 0xDFFF; }

Here is the caller graph for this function:

is_surrogate()

bool mtcore::is_surrogate ( char16_t ch )

constexpr

Checks if UTF-16 character is a surrogate.

Definition at line 143 of file byte_endian.hpp.

{ return ch >= 0xD800 && ch <= 0xDFFF; }

rune_to_str()

CharSeq mtcore::rune_to_str

(

Rune

rune

)

Converts a UTF-32 Rune to a sequence of char.

Here is the caller graph for this function:

rune_to_utf16()

U16Seq mtcore::rune_to_utf16

(

Rune

rune

)

Converts a UTF-32 Rune to a utf-16 sequence.

Here is the caller graph for this function:

rune_to_utf8()

U8Seq mtcore::rune_to_utf8

(

Rune

rune

)

Converts a UTF-32 Rune to a utf-8 sequence.

Here is the caller graph for this function:

slice_from_be_endian() [1/4]

Slice< const char16_t > mtcore::slice_from_be_endian ( SliceConstU16Native s )

inline

Gets a normal slice from a big endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 771 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_be_endian() [2/4]

Slice< const char32_t > mtcore::slice_from_be_endian ( SliceConstU32Native s )

inline

Gets a normal slice from a big endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 781 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_be_endian() [3/4]

Slice< char16_t > mtcore::slice_from_be_endian ( SliceU16Native s )

inline

Gets a normal slice from a big endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 766 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_be_endian() [4/4]

Slice< char32_t > mtcore::slice_from_be_endian ( SliceU32Native s )

inline

Gets a normal slice from a big endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 776 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_le_endian() [1/4]

Slice< const char16_t > mtcore::slice_from_le_endian ( SliceConstU16Native s )

inline

Gets a normal slice from a little endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 750 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_le_endian() [2/4]

Slice< const char32_t > mtcore::slice_from_le_endian ( SliceConstU32Native s )

inline

Gets a normal slice from a little endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 760 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_le_endian() [3/4]

Slice< char16_t > mtcore::slice_from_le_endian ( SliceU16Native s )

inline

Gets a normal slice from a little endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 745 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_le_endian() [4/4]

Slice< char32_t > mtcore::slice_from_le_endian ( SliceU32Native s )

inline

Gets a normal slice from a little endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 755 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_native_endian() [1/4]

Slice< const char16_t > mtcore::slice_from_native_endian ( SliceConstU16Native s )

inline

Gets a normal slice from a native endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 725 of file byte_endian.hpp.

                                                                               {
    return {.head = s.head, .len = s.len};
  }

slice_from_native_endian() [2/4]

Slice< const char32_t > mtcore::slice_from_native_endian ( SliceConstU32Native s )

inline

Gets a normal slice from a native endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 737 of file byte_endian.hpp.

                                                                               {
    return {.head = s.head, .len = s.len};
  }

slice_from_native_endian() [3/4]

Slice< char16_t > mtcore::slice_from_native_endian ( SliceU16Native s )

inline

Gets a normal slice from a native endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 720 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

slice_from_native_endian() [4/4]

Slice< char32_t > mtcore::slice_from_native_endian ( SliceU32Native s )

inline

Gets a normal slice from a native endian slice.

Does NOT flip endianness of data or add BOM

Definition at line 732 of file byte_endian.hpp.

{ return {.head = s.head, .len = s.len}; }

str_rune_iterator()

RuneIterator< char > mtcore::str_rune_iterator ( const Slice< const char > & s )

inline

Rune iterator for a slice of characters.

Definition at line 991 of file byte_endian.hpp.

{ return {.data = s, .strIndex = 0}; }

Here is the caller graph for this function:

str_to_utf16()

template<WriterImpl WI>

auto mtcore::str_to_utf16	(	io::Writer< WI > &	writer,
		const Slice< const char > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-8 string to UTF-16.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-8 string to write
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1660 of file byte_endian.hpp.

                                                    {
    auto runeIter = str_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

str_to_utf32()

template<WriterImpl WI>

auto mtcore::str_to_utf32	(	io::Writer< WI > &	writer,
		const Slice< const char > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-8 string to UTF-32.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-8 string to write
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1371 of file byte_endian.hpp.

                                                    {
    auto runeIter = str_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

str_to_utf8()

template<WriterImpl WI>

auto mtcore::str_to_utf8	(	io::Writer< WI > &	writer,
		const Slice< const char > &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a character sequence to UTF-8 string.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-8 string to write

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1724 of file byte_endian.hpp.

                                                    {
    auto runeIter = str_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf8(rune);
      char8_t curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

u16_detect_endian()

Optional< std::endian > mtcore::u16_detect_endian ( const char16_t ch )

inline

Tries to detect the endian encoding based on a possible BOM mark.

Parameters

ch	Character to detect ordering from (should be a BOM or reverse BOM)

Returns

detected endian or nullopt if couldn't detect

Definition at line 66 of file byte_endian.hpp.

                                                                  {
    if (is_bom(ch)) {
      return endian::machine;
    }
    else if (is_bom_rev_16_bit(ch)) {
      return endian::opposite;
    }
    else {
      return nullopt;
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

u32_detect_endian()

Optional< std::endian > mtcore::u32_detect_endian ( const char32_t ch )

inline

Tries to detect the endian encoding based on a possible BOM mark.

Parameters

ch	Character to detect ordering from (should be a BOM or reverse BOM)

Returns

detected endian or nullopt if couldn't detect

Definition at line 84 of file byte_endian.hpp.

                                                                  {
    if (is_bom(ch)) {
      return endian::machine;
    }
    else if (is_bom_rev_32_bit(ch)) {
      return endian::opposite;
    }
    else {
      return nullopt;
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_rune_iterator() [1/5]

RuneIterator< char16_t > mtcore::utf16_rune_iterator ( const Slice< const char16_t > & s )

inline

Rune iterator for a UTF16 sequence.

Will try to auto detect endianness from BOM. Will drop BOM if present

Definition at line 1003 of file byte_endian.hpp.

                                                                                    {
    if (s.size()) {
      if (const auto encoding = u16_detect_endian(s[0]); encoding.has_value()) {
        return {.data = s.sub(1), .strIndex = 0, .reverseBom = encoding == endian::opposite};
      }
    }
    return {.data = s, .strIndex = 0};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_rune_iterator() [2/5]

RuneIterator< char16_t > mtcore::utf16_rune_iterator ( const SliceConstU16Be & s )

inline

Rune iterator for a big endian UTF16 sequence.

Definition at line 1025 of file byte_endian.hpp.

                                                                              {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::big};
  }

utf16_rune_iterator() [3/5]

RuneIterator< char16_t > mtcore::utf16_rune_iterator ( const SliceConstU16Le & s )

inline

Rune iterator for a little endian UTF16 sequence.

Definition at line 1016 of file byte_endian.hpp.

                                                                              {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::little};
  }

utf16_rune_iterator() [4/5]

RuneIterator< char16_t > mtcore::utf16_rune_iterator ( const SliceU16Be & s )

inline

Rune iterator for a big endian UTF16 sequence.

Definition at line 1043 of file byte_endian.hpp.

                                                                         {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::big};
  }

utf16_rune_iterator() [5/5]

RuneIterator< char16_t > mtcore::utf16_rune_iterator ( const SliceU16Le & s )

inline

Rune iterator for a little endian UTF16 sequence.

Definition at line 1034 of file byte_endian.hpp.

                                                                         {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::little};
  }

utf16_to_str() [1/3]

template<WriterImpl WI>

auto mtcore::utf16_to_str	(	io::Writer< WI > &	writer,
		const Slice< const char16_t > &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-8.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (native endian)

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1608 of file byte_endian.hpp.

                                                    {
    return utf16_to_str(writer, endian_from_native_slice(str));
  }

Here is the call graph for this function:

utf16_to_str() [2/3]

template<WriterImpl WI>

auto mtcore::utf16_to_str	(	io::Writer< WI > &	writer,
		const SliceConstU16Be &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-8.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (big endian)

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1538 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_str(rune);
      char curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_to_str() [3/3]

template<WriterImpl WI>

auto mtcore::utf16_to_str	(	io::Writer< WI > &	writer,
		const SliceConstU16Le &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-8.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (little endian)

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1566 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_str(rune);
      char curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf16_to_utf16be() [1/2]

template<WriterImpl WI>

auto mtcore::utf16_to_utf16be	(	io::Writer< WI > &	writer,
		const Slice< const char16_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts native UTF-16 to UTF-16 Big Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (native) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1848 of file byte_endian.hpp.

                                                    {
    return utf16_to_utf16be(writer, endian_from_native_slice(str), writeBom);
  }

Here is the call graph for this function:

utf16_to_utf16be() [2/2]

template<WriterImpl WI>

auto mtcore::utf16_to_utf16be	(	io::Writer< WI > &	writer,
		const SliceConstU16Native &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts native UTF-16 to UTF-16 Big Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (native) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1808 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::big, char16_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t cur;
      auto seqIter = seq.iter();
      while (seqIter.next().copy_if_present(cur)) {
        if constexpr (std::endian::native != std::endian::big) {
          cur = flip_endian(cur);
        }
        if (auto writeRes = writer.write(cur); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_to_utf16le() [1/2]

template<WriterImpl WI>

auto mtcore::utf16_to_utf16le	(	io::Writer< WI > &	writer,
		const Slice< const char16_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts native UTF-16 to UTF-16 Little Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (native) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1793 of file byte_endian.hpp.

                                                    {
    return utf16_to_utf16le(writer, endian_from_native_slice(str), writeBom);
  }

Here is the call graph for this function:

utf16_to_utf16le() [2/2]

template<WriterImpl WI>

auto mtcore::utf16_to_utf16le	(	io::Writer< WI > &	writer,
		const SliceConstU16Native &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts native UTF-16 to UTF-16 Little Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (native) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1753 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::little, char16_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t cur;
      auto seqIter = seq.iter();
      while (seqIter.next().copy_if_present(cur)) {
        if constexpr (std::endian::native != std::endian::little) {
          cur = flip_endian(cur);
        }
        if (auto writeRes = writer.write(cur); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_to_utf32() [1/3]

template<WriterImpl WI>

auto mtcore::utf16_to_utf32	(	io::Writer< WI > &	writer,
		const Slice< const char16_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-32.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (native endian)
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1496 of file byte_endian.hpp.

                                                    {
    return utf16_to_utf32(writer, endian_from_native_slice(str), writeBom);
  }

Here is the call graph for this function:

utf16_to_utf32() [2/3]

template<WriterImpl WI>

auto mtcore::utf16_to_utf32	(	io::Writer< WI > &	writer,
		const SliceConstU16Be &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-32.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (big endian)
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1464 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if (auto writeres = writer.write(rune); writeres.is_error()) {
        return writeres.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

utf16_to_utf32() [3/3]

template<WriterImpl WI>

auto mtcore::utf16_to_utf32	(	io::Writer< WI > &	writer,
		const SliceConstU16Le &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-32.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (little endian)
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1432 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if (auto writeres = writer.write(rune); writeres.is_error()) {
        return writeres.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_to_utf8() [1/3]

template<WriterImpl WI>

auto mtcore::utf16_to_utf8	(	io::Writer< WI > &	writer,
		const Slice< const char16_t > &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-8.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (native endian)

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1594 of file byte_endian.hpp.

                                                    {
    return utf16_to_utf8(writer, endian_from_native_slice(str));
  }

Here is the call graph for this function:

utf16_to_utf8() [2/3]

template<WriterImpl WI>

auto mtcore::utf16_to_utf8	(	io::Writer< WI > &	writer,
		const SliceConstU16Be &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-8.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (little endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1402 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf8(rune);
      char8_t curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf16_to_utf8() [3/3]

template<WriterImpl WI>

auto mtcore::utf16_to_utf8	(	io::Writer< WI > &	writer,
		const SliceConstU16Le &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-16 string to UTF-8.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-16 string to write (little endian)

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1510 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf8(rune);
      char8_t curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf16be_to_utf16()

template<WriterImpl WI>

auto mtcore::utf16be_to_utf16	(	io::Writer< WI > &	writer,
		const SliceConstU16Be &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-16 Big Endian to Native UTF-16.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (big endian) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1980 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::native, char16_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t cur;
      auto seqIter = seq.iter();
      while (seqIter.next().copy_if_present(cur)) {
        if (auto writeRes = writer.write(cur); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf16be_to_utf16le()

template<WriterImpl WI>

auto mtcore::utf16be_to_utf16le	(	io::Writer< WI > &	writer,
		const SliceConstU16Be &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-16 Big Endian to UTF-16 Little Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1903 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::little, char16_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t cur;
      auto seqIter = seq.iter();
      while (seqIter.next().copy_if_present(cur)) {
        if constexpr (std::endian::native != std::endian::little) {
          cur = flip_endian(cur);
        }
        if (auto writeRes = writer.write(cur); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf16le_to_utf16()

template<WriterImpl WI>

auto mtcore::utf16le_to_utf16	(	io::Writer< WI > &	writer,
		const SliceConstU16Le &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-16 Little Endian to Native UTF-16.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1943 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::native, char16_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t cur;
      auto seqIter = seq.iter();
      while (seqIter.next().copy_if_present(cur)) {
        if (auto writeRes = writer.write(cur); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf16le_to_utf16be()

template<WriterImpl WI>

auto mtcore::utf16le_to_utf16be	(	io::Writer< WI > &	writer,
		const SliceConstU16Le &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-16 Little Endian to UTF-16 Big Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-16 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF16 chars written, or error otherwise

Definition at line 1863 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf16_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::big, char16_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t cur;
      auto seqIter = seq.iter();
      while (seqIter.next().copy_if_present(cur)) {
        if constexpr (std::endian::native != std::endian::big) {
          cur = flip_endian(cur);
        }
        if (auto writeRes = writer.write(cur); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf32_rune_iterator() [1/5]

RuneIterator< char32_t > mtcore::utf32_rune_iterator ( const Slice< const char32_t > & s )

inline

Rune iterator for a UTF32 sequence.

Will try to auto detect endian from BO. Will drop BOM if presentM

Definition at line 1052 of file byte_endian.hpp.

                                                                                    {
    if (s.size()) {
      if (const auto encoding = u32_detect_endian(s[0]); encoding.has_value()) {
        return {.data = s.sub(1), .strIndex = 0, .reverseBom = encoding == endian::opposite};
      }
    }
    return {.data = s, .strIndex = 0};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf32_rune_iterator() [2/5]

RuneIterator< char32_t > mtcore::utf32_rune_iterator ( const SliceConstU32Be & s )

inline

Rune iterator for a big endian UTF32 sequence.

Definition at line 1074 of file byte_endian.hpp.

                                                                              {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::big};
  }

utf32_rune_iterator() [3/5]

RuneIterator< char32_t > mtcore::utf32_rune_iterator ( const SliceConstU32Le & s )

inline

Rune iterator for a little endian UTF32 sequence.

Definition at line 1065 of file byte_endian.hpp.

                                                                              {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::little};
  }

utf32_rune_iterator() [4/5]

RuneIterator< char32_t > mtcore::utf32_rune_iterator ( const SliceU32Be & s )

inline

Rune iterator for a big endian UTF32 sequence.

Definition at line 1092 of file byte_endian.hpp.

                                                                         {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::big};
  }

utf32_rune_iterator() [5/5]

RuneIterator< char32_t > mtcore::utf32_rune_iterator ( const SliceU32Le & s )

inline

Rune iterator for a little endian UTF32 sequence.

Definition at line 1083 of file byte_endian.hpp.

                                                                         {
    return {
      .data = {.head = s.head, .len = s.len}, .strIndex = 0, .reverseBom = std::endian::native != std::endian::little};
  }

utf32_to_str() [1/3]

template<WriterImpl WI>

auto mtcore::utf32_to_str	(	io::Writer< WI > &	writer,
		const Slice< const char32_t > &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to character sequence (UTF-8 encoded chars)

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-32 string to write (native endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1324 of file byte_endian.hpp.

                                                    {
    return utf32_to_str(writer, endian_from_native_slice(str));
  }

Here is the call graph for this function:

utf32_to_str() [2/3]

template<WriterImpl WI>

auto mtcore::utf32_to_str	(	io::Writer< WI > &	writer,
		const SliceConstU32Be &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to character sequence (UTF-8 encoded chars)

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-32 string to write (big endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1268 of file byte_endian.hpp.

                                                    {
    char32_t cur;
    auto iter      = utf32_rune_iterator(str);
    size_t written = 0;
    while (iter.next().copy_if_present(cur)) {
      auto seq = rune_to_str(cur);
      char curCh;
      auto iter2 = seq.iter();
      while (iter2.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf32_to_str() [3/3]

template<WriterImpl WI>

auto mtcore::utf32_to_str	(	io::Writer< WI > &	writer,
		const SliceConstU32Le &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to character sequence (UTF-8 encoded chars)

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-32 string to write (little endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1296 of file byte_endian.hpp.

                                                    {
    char32_t cur;
    auto iter      = utf32_rune_iterator(str);
    size_t written = 0;
    while (iter.next().copy_if_present(cur)) {
      auto seq = rune_to_str(cur);
      char curCh;
      auto iter2 = seq.iter();
      while (iter2.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf32_to_utf16() [1/3]

template<WriterImpl WI>

auto mtcore::utf32_to_utf16	(	io::Writer< WI > &	writer,
		const Slice< const char32_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to UTF-16 string Can optionally write a BOM to the prefix.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char16_t as input)
str	UTF-32 string to write (native endian)
writeBom	If it should write the BOM (will write it in native endian)

Returns

Result with number of UTF16 chars written, or error otherwise

Definition at line 1184 of file byte_endian.hpp.

                                                    {
    return utf32_to_utf16(writer, endian_from_native_slice(str), writeBom);
  }

Here is the call graph for this function:

utf32_to_utf16() [2/3]

template<WriterImpl WI>

auto mtcore::utf32_to_utf16	(	io::Writer< WI > &	writer,
		const SliceConstU32Be &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to UTF-16 string Can optionally write a BOM to the prefix.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char16_t as input)
str	UTF-32 string to write (big endian)
writeBom	If it should write the BOM (will write it in native endian)

Returns

Result with number of UTF16 chars written, or error otherwise

Definition at line 1108 of file byte_endian.hpp.

                                                    {
    char32_t cur;
    auto iter      = utf32_rune_iterator(str);
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (iter.next().copy_if_present(cur)) {
      auto seq = rune_to_utf16(cur);
      char16_t curCh;
      auto iter2 = seq.iter();
      while (iter2.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf32_to_utf16() [3/3]

template<WriterImpl WI>

auto mtcore::utf32_to_utf16	(	io::Writer< WI > &	writer,
		const SliceConstU32Le &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to UTF-16 string Can optionally write a BOM to the prefix.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char16_t as input)
str	UTF-32 string to write (little endian)
writeBom	If it should write the BOM (will write it in native endian)

Returns

Result with number of UTF16 chars written, or error otherwise

Definition at line 1146 of file byte_endian.hpp.

                                                    {
    char32_t cur;
    auto iter      = utf32_rune_iterator(str);
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (iter.next().copy_if_present(cur)) {
      auto seq = rune_to_utf16(cur);
      char16_t curCh;
      auto iter2 = seq.iter();
      while (iter2.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf32_to_utf32be() [1/2]

template<WriterImpl WI>

auto mtcore::utf32_to_utf32be	(	io::Writer< WI > &	writer,
		const Slice< const char32_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Native Endian to UTF-32 Big Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (big endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2102 of file byte_endian.hpp.

                                                    {
    return utf32_to_utf32be(writer, endian_from_native_slice(str), writeBom);
  }

Here is the call graph for this function:

utf32_to_utf32be() [2/2]

template<WriterImpl WI>

auto mtcore::utf32_to_utf32be	(	io::Writer< WI > &	writer,
		const SliceConstU32Native &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Native Endian to UTF-32 Big Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (big endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2067 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf32_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::big, char32_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if constexpr (std::endian::native != std::endian::big) {
        rune = flip_endian(rune);
      }
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf32_to_utf32le() [1/2]

template<WriterImpl WI>

auto mtcore::utf32_to_utf32le	(	io::Writer< WI > &	writer,
		const Slice< const char32_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Native Endian to UTF-32 Little Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2052 of file byte_endian.hpp.

                                                    {
    return utf32_to_utf32le(writer, endian_from_native_slice(str), writeBom);
  }

Here is the call graph for this function:

utf32_to_utf32le() [2/2]

template<WriterImpl WI>

auto mtcore::utf32_to_utf32le	(	io::Writer< WI > &	writer,
		const SliceConstU32Native &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Native Endian to UTF-32 Little Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2017 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf32_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::little, char32_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if constexpr (std::endian::native != std::endian::little) {
        rune = flip_endian(rune);
      }
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf32_to_utf8() [1/3]

template<WriterImpl WI>

auto mtcore::utf32_to_utf8	(	io::Writer< WI > &	writer,
		const Slice< const char32_t > &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to UTF-8 string.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char8_t as input)
str	UTF-32 string to write (native endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1254 of file byte_endian.hpp.

                                                    {
    return utf32_to_utf8(writer, endian_from_native_slice(str));
  }

Here is the call graph for this function:

utf32_to_utf8() [2/3]

template<WriterImpl WI>

auto mtcore::utf32_to_utf8	(	io::Writer< WI > &	writer,
		const SliceConstU32Be &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to UTF-8 string.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char8_t as input)
str	UTF-32 string to write (big endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1198 of file byte_endian.hpp.

                                                    {
    char32_t cur;
    auto iter      = utf32_rune_iterator(str);
    size_t written = 0;
    while (iter.next().copy_if_present(cur)) {
      auto seq = rune_to_utf8(cur);
      char8_t curCh;
      auto iter2 = seq.iter();
      while (iter2.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

utf32_to_utf8() [3/3]

template<WriterImpl WI>

auto mtcore::utf32_to_utf8	(	io::Writer< WI > &	writer,
		const SliceConstU32Le &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-32 string to UTF-8 string.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char8_t as input)
str	UTF-32 string to write (little endian)

Returns

Result with number of UTF8 chars written, or error otherwise

Definition at line 1226 of file byte_endian.hpp.

                                                    {
    char32_t cur;
    auto iter      = utf32_rune_iterator(str);
    size_t written = 0;
    while (iter.next().copy_if_present(cur)) {
      auto seq = rune_to_utf8(cur);
      char8_t curCh;
      auto iter2 = seq.iter();
      while (iter2.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf32be_to_utf32()

template<WriterImpl WI>

auto mtcore::utf32be_to_utf32	(	io::Writer< WI > &	writer,
		const SliceConstU32Be &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Big Endian to UTF-32 Native Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2219 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf32_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::native, char32_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

utf32be_to_utf32le()

template<WriterImpl WI>

auto mtcore::utf32be_to_utf32le	(	io::Writer< WI > &	writer,
		const SliceConstU32Be &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Big Endian to UTF-32 Little Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2152 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf32_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::little, char32_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if constexpr (std::endian::native != std::endian::little) {
        rune = flip_endian(rune);
      }
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

utf32le_to_utf32()

template<WriterImpl WI>

auto mtcore::utf32le_to_utf32	(	io::Writer< WI > &	writer,
		const SliceConstU32Le &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Little Endian to UTF-32 Native Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2187 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf32_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::native, char32_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

utf32le_to_utf32be()

template<WriterImpl WI>

auto mtcore::utf32le_to_utf32be	(	io::Writer< WI > &	writer,
		const SliceConstU32Le &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Converts UTF-32 Little Endian to UTF-32 Big Endian.

Template Parameters

WI	Writer Type

Parameters

writer	Writer
str	UTF-32 (little endian) to write
writeBom	If it should write BOM

Returns

Number of UTF32 chars written, or error otherwise

Definition at line 2117 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf32_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(endian_bom<std::endian::big, char32_t>); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if constexpr (std::endian::native != std::endian::big) {
        rune = flip_endian(rune);
      }
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

utf8_rune_iterator()

RuneIterator< char8_t > mtcore::utf8_rune_iterator ( const Slice< const char8_t > & s )

inline

Rune iterator for a UTF8 sequence.

Definition at line 997 of file byte_endian.hpp.

{ return {.data = s, .strIndex = 0}; }

Here is the caller graph for this function:

utf8_to_str()

template<WriterImpl WI>

auto mtcore::utf8_to_str	(	io::Writer< WI > &	writer,
		const Slice< const char8_t > &	str ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-8 string to character sequence.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-8 string to write

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1696 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf8_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_str(rune);
      char curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf8_to_utf16()

template<WriterImpl WI>

auto mtcore::utf8_to_utf16	(	io::Writer< WI > &	writer,
		const Slice< const char8_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-8 string to UTF-16.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-8 string to write
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1623 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf8_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      auto seq = rune_to_utf16(rune);
      char16_t curCh;
      auto charIter = seq.iter();
      while (charIter.next().copy_if_present(curCh)) {
        if (auto writeRes = writer.write(curCh); writeRes.is_error()) {
          return writeRes.error();
        }
        ++written;
      }
    }
    return success(written);
  }

Here is the call graph for this function:

utf8_to_utf32()

template<WriterImpl WI>

auto mtcore::utf8_to_utf32	(	io::Writer< WI > &	writer,
		const Slice< const char8_t > &	str,
		bool	writeBom = false ) -> Result<size_t, typename io::Writer<WI>::ErrType>

Will convert a UTF-8 string to UTF-32.

Template Parameters

WI	Writer type

Parameters

writer	Writer to write output to (should take char as input)
str	UTF-8 string to write
writeBom	If it should write a BOM

Returns

Result with number of UTF32 chars written, or error otherwise

Definition at line 1339 of file byte_endian.hpp.

                                                    {
    auto runeIter = utf8_rune_iterator(str);
    char32_t rune;
    size_t written = 0;
 
    if (writeBom) {
      if (auto res = writer.write(bom); res.is_error()) {
        return res.error();
      }
      ++written;
    }
 
    while (runeIter.next().copy_if_present(rune)) {
      if (auto writeRes = writer.write(rune); writeRes.is_error()) {
        return writeRes.error();
      }
      ++written;
    }
    return success(written);
  }

Here is the call graph for this function:

Variable Documentation

bom

char32_t mtcore::bom = 0xFEFF

constexpr

Native representation of Byte Order Mark (BOM)

Definition at line 39 of file byte_endian.hpp.

oppositeEndian

template<std::endian E = std::endian::native>

auto mtcore::oppositeEndian = E == std::endian::big ? std::endian::little : std::endian::big

constexpr

Returns the opposite endianness of a given endian (default is opposite of the native endian)

Definition at line 158 of file byte_endian.hpp.