BloombergLP::bslx::InStreamFunctions::bdexStreamInImp

Unexternalize an enumeration VALUE_TYPE from stream into variable.

Synopsis

Declared in <bslx_instreamfunctions.h>

template<
    class STREAM,
    class VALUE_TYPE>
STREAM&
bdexStreamInImp(
    STREAM& stream,
    VALUE_TYPE& variable,
    int version,
    IsEnumType const& category);

Description

Assign to the specified variable the VALUE_TYPE value read from the specified input stream, and return a reference to stream. The specified version is ignored. If stream is initially invalid, this operation has no effect. If version is not supported by VALUE_TYPE, variable is unaltered and stream is invalidated, but otherwise unmodified. If version is supported but stream becomes invalid during this operation, variable has an undefined, but valid, state. Note that this function is called only for enumeration types and that this function is for internal use only. See the bslx package‐level documentation for more information on BDEX streaming of value‐semantic types and containers.

Return Value

a reference to stream

Parameters

Name

Description

stream

input stream from which to read

variable

enumeration to receive the unexternalized value

version

ignored BDEX version (accepted for overload uniformity)

category

tag selecting the enumeration overload

Created with MrDocs