std::codecvt<InternT,ExternT,StateT>::length, do_length

Определено в заголовке <locale>

Определено в заголовке `<locale>`
public: int length( StateT& state, const ExternT* from, const ExternT* from_end, std::size_t max ) const;	(1)
protected: virtual int do_length( StateT& state, const ExternT* from, const ExternT* from_end, std::size_t max ) const;	(2)

public:
int length( StateT& state, const ExternT* from, const ExternT* from_end,
            std::size_t max ) const;

(1)

protected:
virtual int do_length( StateT& state, const ExternT* from, const ExternT* from_end,
                       std::size_t max ) const;

(2)

1) Публичный член-функция, вызывает член-функцию do_length самого производного класса.

2) Попытка преобразовать ExternT символов из массива символов, определенного [from, from_end), с начальным состоянием преобразования state, в максимум max InternT символов и возвращает количество ExternT символов, которые такое преобразование потребляет. Изменяет state так, как если бы выполнено do_in(state, from, from_end, from, to, to + max, to) для некоторого воображаемого буфера вывода [to, to + max).

Значение возврата

Количество ExternT символов, которые были бы потреблены при преобразовании do_in() до тех пор, пока все from_end - from символы не будут потреблены или будет произведено max InternT символов, или произойдет ошибка преобразования.

Непреобразующая специализация std::codecvt<char, char, std::mbstate_t> возвращает std::min(max, from_end - from).

Пример

#include <iostream>
#include <locale>
#include <string>
 
int main()
{
    using facet_type = std::codecvt<char16_t, char, std::mbstate_t>;
 
    // narrow multibyte encoding
    std::string s = "z\u00df\u6c34\U0001d10b"; // or u8"zß水𝄋"
              // or "\x7a\xc3\x9f\xe6\xb0\xb4\xf0\x9d\x84\x8b"
 
    std::setlocale(LC_ALL, "en_US.UTF-8");
    facet_type const& codecvt_facet = std::use_facet<facet_type>(std::locale());
    std::mbstate_t mb = std::mbstate_t();
    std::cout << "Only the first "
              << codecvt_facet.length(mb, s.data(), s.data() + s.size(), 2)
              << " bytes out of " << s.size() << " would be consumed"
                 " to produce the first 2 characters\n";
}

Вывод:

Only the first 3 bytes out of 10 would be consumed to produce the first 2 characters

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR	Применено к	Поведение, как опубликовано	Корректное поведение
LWG 75	C++98	эффект на `state` не был указан	указан
LWG 305	C++98	`std::codecvt<wchar_t, char, std::mbstate_t>::do_length` требовалось вернуть `std::min(max, from_end - from)`	не требуется

См. также

do_in

[virtual]

преобразует строку из ExternT в InternT, например, при чтении из файла
(виртуальная защищенная функция-член)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/locale/codecvt/length