std::optional

template< class T >
class optional;

La plantilla de clase std::optional gestiona un valor contenido opcional, es decir, un valor que puede o no estar presente.

Un caso de uso común para optional es el valor de retorno de una función que puede fallar. En comparación con otros enfoques, como std::pair<T, bool>, optional maneja bien objetos costosos de construir y es más legible, ya que la intención se expresa explícitamente.

Cualquier instancia de optional en cualquier momento dado contiene un valor o no contiene un valor.

Si un optional contiene un valor, se garantiza que el valor está anidado dentro del objeto optional. Por lo tanto, un objeto optional modela un objeto, no un puntero, aunque operator*() y operator->() estén definidos.

Cuando un objeto de tipo optional<T> es convertido contextualmente a bool, la conversión devuelve true si el objeto contiene un valor y false si no contiene un valor.

El objeto optional contiene un valor en las siguientes condiciones:

• El objeto se inicializa/asigna con un valor de tipo T u otro optional que contiene un valor.

El objeto no contiene un valor en las siguientes condiciones:

• El objeto se inicializa por defecto.
• El objeto se inicializa/asigna con un valor de tipo std::nullopt_t o un objeto optional que no contiene un valor.
• Se llama a la función miembro reset().

No existen referencias, funciones, arreglos o (posiblemente cv-cualificados) void opcionales; un programa está mal formado si se instancia un optional con dicho tipo. Además, un programa está mal formado si se instancia un optional con los tipos de etiqueta (posiblemente cv-cualificados) std::nullopt_t o std::in_place_t.

Parámetros de plantilla

Tipos anidados

Todos los requisitos sobre los tipos de iterador de un Container se aplican también al tipo iterator de optional .

Miembros de datos

Funciones miembro

Funciones no miembro

Clases auxiliares

Asistentes

Especializaciones auxiliares

Esta especialización de ranges::enable_view hace que optional satisfaga view .

Esta especialización de format_kind desactiva el soporte de formato de rangos de optional .

Guías de deducción

Notas

Ejemplo

#include <iostream>
#include <optional>
#include <string>
// optional puede usarse como tipo de retorno de una fábrica que puede fallar
std::optional<std::string> create(bool b)
{
    if (b)
        return "Godzilla";
    return {};
}
// std::nullopt puede usarse para crear cualquier std::optional (vacío)
auto create2(bool b)
{
    return b ? std::optional<std::string>{"Godzilla"} : std::nullopt;
}
int main()
{
    std::cout << "create(false) returned "
              << create(false).value_or("empty") << '\n';
    // las funciones fábrica que retornan optional son utilizables como condiciones de while e if
    if (auto str = create2(true))
        std::cout << "create2(true) returned " << *str << '\n';
}

create(false) returned empty
create2(true) returned Godzilla

Informes de defectos

Los siguientes informes de defectos que modifican el comportamiento se aplicaron retroactivamente a los estándares de C++ publicados anteriormente.

Véase también