BloombergLP::bdlt::bdexStreamIn

Load into variable the enum value read from stream using BDEX.

Synopsis

Declared in <bdlt_dayofweek.h>

template<class STREAM>
STREAM&
bdexStreamIn(
    STREAM& stream,
    DayOfWeek::Enum& variable,
    int version);

Description

Load into the specified variable the DayOfWeek::Enum value read from the specified input stream using the specified version format, and return a reference to stream. If stream is initially invalid, this operation has no effect. If version is not supported by DayOfWeek, variable is unaltered and stream is invalidated, but otherwise unmodified. If version is supported by DayOfWeek but stream becomes invalid during this operation, variable has an undefined, but valid, state. The behavior is undefined unless STREAM is BDEX‐compliant. Note that no version is read from stream. 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 providing the BDEX encoding

variable

receives the streamed enumeration value

version

BDEX format version to use

Created with MrDocs