[#mrdocs-Expected-01]
= xref:mrdocs.adoc[mrdocs]::xref:mrdocs/Expected-0a.adoc[Expected]<T&, E>
:relfileprefix: ../
:mrdocs:

Expected specialization for lvalue references. Holds either a bound reference to `T` or an unexpected error `E`.

== Synopsis

Declared in `<mrdocs/Support/Expected.hpp>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class T,
    class E>
class xref:mrdocs/Expected-0a.adoc[Expected]<T&, E>;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Expected-01/error_type.adoc[`error_type`] 
| Error type carried when disengaged.
| xref:mrdocs/Expected-01/rebind.adoc[`rebind`] 
| Rebind the reference to another value type while keeping `E`.
| xref:mrdocs/Expected-01/unexpected_type.adoc[`unexpected_type`] 
| Convenience alias for the unexpected wrapper.
| xref:mrdocs/Expected-01/value_type.adoc[`value_type`] 
| Referenced value type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Expected-01/2constructor-04.adoc[`Expected`]         [.small]#[constructor]#
| Constructors
| xref:mrdocs/Expected-01/2destructor.adoc[`~Expected`] [.small]#[destructor]#
| Destroy the held error when disengaged.
| xref:mrdocs/Expected-01/operator_assign-0b.adoc[`operator=`] 
| Assignment operators
| xref:mrdocs/Expected-01/and_then-00.adoc[`and_then`] 
| `and_then` overloads
| xref:mrdocs/Expected-01/emplace-05.adoc[`emplace`] 
| `emplace` overloads
| xref:mrdocs/Expected-01/error-01.adoc[`error`] 
| `error` overloads
| xref:mrdocs/Expected-01/error_or-08.adoc[`error_or`] 
| `error_or` overloads
| xref:mrdocs/Expected-01/has_value.adoc[`has_value`] 
| Check whether the Expected currently contains a reference.
| xref:mrdocs/Expected-01/operator_star-068.adoc[`operator*`] 
| Dereference operators
| xref:mrdocs/Expected-01/operator_ptr-05.adoc[`operator‐>`] 
| Access the bound reference pointer; undefined if disengaged.
| xref:mrdocs/Expected-01/or_else-07.adoc[`or_else`] 
| `or_else` overloads
| xref:mrdocs/Expected-01/swap.adoc[`swap`] 
| Swap state with another reference Expected.
| xref:mrdocs/Expected-01/transform-09.adoc[`transform`] 
| `transform` overloads
| xref:mrdocs/Expected-01/transform_error-08.adoc[`transform_error`] 
| `transform_error` overloads
| xref:mrdocs/Expected-01/value-03.adoc[`value`] 
| `value` overloads
| xref:mrdocs/Expected-01/value_or-0c.adoc[`value_or`] 
| `value_or` overloads
| xref:mrdocs/Expected-01/2conversion.adoc[`operator bool`] 
| Return true when a reference is bound.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:mrdocs/Expected-01/p_.adoc[`p_`] [.small]#[variant member]#
| Pointer to the referenced value when engaged.
| xref:mrdocs/Expected-01/unex_.adoc[`unex_`] [.small]#[variant member]#
| Stored unexpected error when disengaged.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:mrdocs/operator_eq-087.adoc[mrdocs::operator==]`
| Equality operator
| `xref:mrdocs/operator_eq-0cf.adoc[mrdocs::operator==]`
| Equality operator
| `xref:mrdocs/operator_eq-0782.adoc[mrdocs::operator==]`
| Equality operator
| `xref:mrdocs/swap-00.adoc[mrdocs::swap]`
| 
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#