core/io/encodings/utf16/utf16-docs.factor

   1 USING: help.markup help.syntax io.encodings strings ;
   2 IN: io.encodings.utf16
   3
   4 ARTICLE: "io.encodings.utf16" "UTF-16"
   5 "The UTF-16 encoding is a variable-width encoding. Unicode code points are encoded as 2 or 4 byte sequences. There are three encoding descriptor classes for working with UTF-16, depending on endianness or the presence of a BOM:"
   6 { $subsection utf16 }
   7 { $subsection utf16le }
   8 { $subsection utf16be }
   9 { $subsection utf16n } ;
  10
  11 ABOUT: "io.encodings.utf16"
  12
  13 HELP: utf16le
  14 { $class-description "The encoding descriptor for UTF-16LE, that is, UTF-16 in little endian, without a byte order mark. Streams can be made which read or write wth this encoding." }
  15 { $see-also "encodings-introduction" } ;
  16
  17 HELP: utf16be
  18 { $class-description "The encoding descriptor for UTF-16BE, that is, UTF-16 in big endian, without a byte order mark. Streams can be made which read or write wth this encoding." }
  19 { $see-also "encodings-introduction" } ;
  20
  21 HELP: utf16
  22 { $class-description "The encoding descriptor for UTF-16, that is, UTF-16 with a byte order mark. This is the most useful for general input and output in UTF-16. Streams can be made which read or write wth this encoding." }
  23 { $see-also "encodings-introduction" } ;
  24
  25 HELP: utf16n
  26 { $class-description "The encoding descriptor for UTF-16 without a byte order mark in native endian order. This is useful mostly for FFI calls which take input of strings of the type wchar_t*" }
  27 { $see-also "encodings-introduction" } ;
  28
  29 { utf16 utf16le utf16be utf16n } related-words