BloombergLP::bslx::InStreamFunctions::bdexStreamIn

BDEX‐stream variable from stream (version computed if needed).

Synopsis

Declared in <bslx_instreamfunctions.h>

template<
    class STREAM,
    class VALUE_TYPE>
STREAM&
bdexStreamIn(
    STREAM& stream,
    VALUE_TYPE& variable);

Description

Assign to the specified variable the VALUE_TYPE value read from the specified input stream, and return a reference to stream. If stream is initially invalid, this operation has no effect. If needed, first read the version information from the stream and if this version is not supported by VALUE_TYPE, stream is invalidated, but otherwise unmodified. If stream becomes invalid during this operation, variable has an undefined, but valid, state. Note that the version is only needed when the (template parameter) VALUE_TYPE is a bsl::vector or a user‐defined type. 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

object to receive the unexternalized value

Created with MrDocs