std::codecvt<InternT,ExternT,StateT>::out, do_out

public:
result out( StateT& state,
            const InternT* from,
            const InternT* from_end,
            const InternT*& from_next,
            ExternT* to,
            ExternT* to_end,
            ExternT*& to_next ) const;

protected:
virtual result do_out( StateT& state,
                       const InternT* from,
                       const InternT* from_end,
                       const InternT*& from_next,
                       ExternT* to,
                       ExternT* to_end,
                       ExternT*& to_next ) const;

Если этот фасет codecvt не определяет преобразование, символы не преобразуются. to_next устанавливается равным to, state не изменяется, а функция возвращает std::codecvt_base::noconv.

do_out(state, from, from + 1, from_next, to, to_end, to_next) должен возвращать ok, если

• этот фасет codecvt используется в basic_filebuf, и
• do_out(state, from, from_end, from_next, to, to_end, to_next) возвращал бы ok, когда from != from_end.

Возвращаемое значение

Значение типа std::codecvt_base::result, указывающее статус выполнения следующим образом:

Специализация без преобразования std::codecvt<char, char, std::mbstate_t> всегда возвращает std::codecvt_base::noconv.

Примечания

Требуется, чтобы from <= from_end && to <= to_end и чтобы state находилось либо в начальном состоянии сдвига, либо было получено преобразованием предшествующих символов последовательности.

Хотя codecvt поддерживает преобразования N:M (например, из UTF-16 в UTF-8, где для определения выходных символов могут потребоваться два внутренних символа), std::basic_filebuf может использовать только фасеты codecvt, определяющие преобразование 1:N; то есть при записи в файл он должен уметь обрабатывать по одному внутреннему символу за раз.

При выполнении преобразований N:M эта функция может вернуть std::codecvt_base::partial после считывания всех исходных символов (from_next == from_end). Это означает, что для завершения преобразования требуется ещё один внутренний символ (например, при преобразовании из UTF-16 в UTF-8, если последний символ в исходном буфере — старший суррогат).

Воздействие на state намеренно не определено. В стандартных фасетах он используется для поддержания состояния сдвига, как при вызове std::wcsrtombs, и поэтому обновляется с учётом состояния сдвига после последнего успешно преобразованного символа. Однако пользовательский фасет может использовать его для поддержания любого другого состояния, например для подсчёта числа встреченных специальных символов.

Пример

#include <iostream>
#include <locale>
#include <string>

int main()
{
    std::locale::global(std::locale("en_US.utf8"));
    auto& f = std::use_facet<std::codecvt<wchar_t, char, std::mbstate_t>>(std::locale());
    std::wstring internal = L"z\u00df\u6c34\U0001f34c"; // L"zß水🍌"
    
    // note that the following can be done with wstring_convert
    std::mbstate_t mb{}; // initial shift state
    std::string external(internal.size() * f.max_length(), '\0'); 
    const wchar_t* from_next;
    char* to_next;
    f.out(mb, &internal[0], &internal[internal.size()], from_next,
              &external[0], &external[external.size()], to_next);
    // error checking skipped for brevity
    external.resize(to_next - &external[0]);

    std::cout << "The string in narrow multibyte encoding: " << external << '\n';
}

The string in narrow multibyte encoding: zß水🍌

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

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

См. также