Spec-Zone.ru › C++

std::from_chars

Определено в заголовочном файле <charconv>
std::from_chars_result
    from_chars( const char* first, const char* last,
                /* integer-type */& value, int base = 10 );
(1) (начиная с C++17)
(constexpr начиная с C++23)
std::from_chars_result
    from_chars( const char* first, const char* last,
                /* floating-point-type */& value,
                std::chars_format fmt = std::chars_format::general );
(2) (начиная с C++17)

Анализирует последовательность символов [first, last) на соответствие описанному ниже шаблону. Если ни один символ не соответствует шаблону или значение, полученное при разборе соответствующих символов, не представимо типом value, value не изменяется; в противном случае символы, соответствующие шаблону, интерпретируются как текстовое представление арифметического значения, которое сохраняется в value.

1) Парсеры целых чисел: ожидается шаблон, идентичный используемому std::strtol в локали по умолчанию ("C") и с заданным ненулевым основанием системы счисления, за исключением того, что
  • префиксы "0x" или "0X" не распознаются, если base равен 16
  • распознаётся только знак минус (но не знак плюс), и только для целочисленных типов со знаком типа value
  • начальные пробельные символы не игнорируются.
Библиотека предоставляет перегрузки для всех типов целых чисел со знаком и без знакабез квалификаторов cv(начиная с C++23), а также для char в качестве ссылочного типа параметра value. 2) Парсеры чисел с плавающей точкой: ожидается шаблон, идентичный используемому std::strtod в локали по умолчанию ("C"), за исключением того, что
  • знак плюс не распознаётся вне экспоненты (в начале допускается только знак минус)
  • если в fmt задано std::chars_format::scientific, но не задано std::chars_format::fixed, часть с экспонентой обязательна (в противном случае она необязательна)
  • если в fmt задано std::chars_format::fixed, но не задано std::chars_format::scientific, необязательная экспонента не допускается
  • если fmt равно std::chars_format::hex, префикс "0x" или "0X" не допускается (строка "0x123" разбирается как значение "0" с неразобранным остатком "x123")
  • начальные пробельные символы не игнорируются.
В любом случае результирующее значение является одним из не более чем двух значений с плавающей точкой, ближайших к значению строки, соответствующей шаблону, после округления согласно std::round_to_nearest.
Библиотека предоставляет перегрузки для всех типов с плавающей точкой без квалификаторов cvстандартных(до C++23) в качестве ссылочного типа параметра value.

Параметры

first, last - допустимый диапазон символов для разбора
value - выходной параметр, в который при успешном выполнении сохраняется разобранное значение
base - основание системы счисления: значение от 2 до 36 включительно.
fmt - форматирование числа с плавающей точкой; битовая маска типа std::chars_format

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

При успешном выполнении возвращает значение типа std::from_chars_result, такое что ptr указывает на первый символ, не соответствующий шаблону, либо имеет значение, равное last, если все символы соответствуют шаблону и ec инициализировано значением по умолчанию.

Если соответствия шаблону нет, возвращает значение типа std::from_chars_result, такое что ptr равно first, а ec равно std::errc::invalid_argument. value не изменяется.

Если шаблон совпал, но разобранное значение не входит в диапазон, представимый типом value, возвращает значение типа std::from_chars_result, такое что ec равно std::errc::result_out_of_range, а ptr указывает на первый символ, не соответствующий шаблону. value не изменяется.

Исключения

Ничего не выбрасывает.

Примечания

В отличие от других функций разбора в библиотеках C++ и C, std::from_chars не зависит от локали, не выделяет память и не генерирует исключений. Предоставляется лишь небольшое подмножество политик разбора, используемых другими библиотеками (например, std::sscanf). Это позволяет реализовать функцию максимально быстро для типичных сценариев с высокой пропускной способностью, например для обмена данными в текстовом формате (JSON или XML).

Гарантия того, что std::from_chars может точно восстановить любое значение с плавающей точкой, отформатированное с помощью std::to_chars, предоставляется только в том случае, если обе функции взяты из одной и той же реализации.

Шаблон, состоящий из знака без следующих за ним цифр, считается шаблоном, которому ничто не соответствует.

Макрос проверки функциональности Значение Стандарт Функциональность
__cpp_lib_to_chars 201611L (C++17) Элементарные преобразования строк (std::from_chars, std::to_chars)
202306L (C++26) Проверка успешного выполнения или ошибки функций <charconv>
__cpp_lib_constexpr_charconv 202207L (C++23) Добавление модификаторов constexpr к перегрузкам std::from_chars и std::to_chars для целочисленных типов

Пример

#include <cassert>
#include <charconv>
#include <iomanip>
#include <iostream>
#include <optional>
#include <string_view>
#include <system_error>

int main()
{
    for (std::string_view const str : {"1234", "15 foo", "bar", " 42", "5000000000"})
    {
        std::cout << "String: " << std::quoted(str) << ". ";
        int result{};
        auto [ptr, ec] = std::from_chars(str.data(), str.data() + str.size(), result);

        if (ec == std::errc())
            std::cout << "Result: " << result << ", ptr -> " << std::quoted(ptr) << '\n';
        else if (ec == std::errc::invalid_argument)
            std::cout << "This is not a number.\n";
        else if (ec == std::errc::result_out_of_range)
            std::cout << "This number is larger than an int.\n";
    }

    // C++23's constexpr from_char demo / C++26's operator bool() demo:
    auto to_int = [](std::string_view s) -> std::optional<int>
    {
        int value{};
#if __cpp_lib_to_chars >= 202306L
        if (std::from_chars(s.data(), s.data() + s.size(), value))
#else
        if (std::from_chars(s.data(), s.data() + s.size(), value).ec == std::errc{})
#endif
            return value;
        else
            return std::nullopt;
    };

    assert(to_int("42") == 42);
    assert(to_int("foo") == std::nullopt);
#if __cpp_lib_constexpr_charconv and __cpp_lib_optional >= 202106
    static_assert(to_int("42") == 42);
    static_assert(to_int("foo") == std::nullopt);
#endif
}

Вывод:

String: "1234". Result: 1234, ptr -> ""
String: "15 foo". Result: 15, ptr -> " foo"
String: "bar". This is not a number.
String: " 42". This is not a number.
String: "5000000000". This number is larger than an int.

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

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

DR Применено к Опубликованное поведение Правильное поведение
LWG 2955 C++17 эта функция находилась в <utility> и использовала std::error_code перемещена в <charconv> и использует std::errc
LWG 3373 C++17 std::from_chars_result могла иметь дополнительные члены дополнительные члены запрещены

См. также

from_chars_result
(C++17)
возвращаемый тип функции std::from_chars
(класс)
to_chars
(C++17)
преобразует целое число или число с плавающей точкой в последовательность символов
(функция)
stoistolstoll
(C++11)(C++11)(C++11)
преобразуют строку в целое число со знаком
(функция)
stofstodstold
(C++11)(C++11)(C++11)
преобразуют строку в значение с плавающей точкой
(функция)
strtolstrtoll
(C++11)
преобразуют байтовую строку в целочисленное значение
(функция)
strtofstrtodstrtold
преобразуют байтовую строку в значение с плавающей точкой
(функция)
scanffscanfsscanf
считывают форматированный ввод из stdin, файлового потока или буфера
(функция)
operator>>
извлекает форматированные данные
(открытая функция-член std::basic_istream<CharT,Traits>)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/utility/from_chars

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API