utf8.status.h.xml 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. <chapter xml:id="utf8.status.h">
  2. <title><tt>__vic/utf8/status.h</tt></title>
  3. <chapter xml:id="utf8--status">
  4. <title><tt>utf8::status</tt></title>
  5. <code-block lang="C++">
  6. enum class utf8::status
  7. {
  8. ok = 0,
  9. eof,
  10. // Errors
  11. no_leading_byte,
  12. truncated_code_point,
  13. overlong_encoding,
  14. code_point_too_big
  15. };
  16. using utf8::status_t = utf8::status; // for C++98
  17. </code-block>
  18. <p>Значения, возвращаемые функцией <tt>parse()</tt> класса
  19. <xref to="utf8--reader"/>.</p>
  20. <list style="bulleted">
  21. <item><tt>ok</tt> - code point успешно прочитан</item>
  22. <item><tt>eof</tt> - больше нечего читать</item>
  23. <item><tt>no_leading_byte</tt> - многобайтовая последовательность
  24. без ведущего байта</item>
  25. <item><tt>truncated_code_point</tt> - оборванная многобайтовая
  26. последовательность</item>
  27. <item><tt>overlong_encoding</tt> - использовано чрезмерно длинное
  28. представление</item>
  29. <item><tt>code_point_too_big</tt> - code point имеет слишком большое
  30. значение</item>
  31. </list>
  32. </chapter>
  33. <chapter xml:id="utf8--is_error">
  34. <title><tt>utf8::is_error()</tt></title>
  35. <code-block lang="C++">
  36. constexpr bool utf8::is_error(utf8::status s);
  37. </code-block>
  38. <p>Возвращает <tt>false</tt> для значений <tt>utf8::status::ok</tt> и
  39. <tt>utf8::status::eof</tt>. В остальных случаях возвращается <tt>true</tt>.</p>
  40. </chapter>
  41. <chapter xml:id="utf8--throw_if_error">
  42. <title><tt>utf8::throw_if_error()</tt></title>
  43. <code-block lang="C++">
  44. bool utf8::throw_if_error(utf8::status s);
  45. </code-block>
  46. <p>Бросает исключение из <xref to="utf8.exceptions.h"/> в случае
  47. <tt>is_error(s)</tt>. Возвращает <tt>true</tt> для <tt>utf8::status::ok</tt>
  48. или <tt>false</tt> для <tt>utf8::status::eof</tt>.</p>
  49. </chapter>
  50. </chapter>