[#ParamsStream-02]
= ParamsStream
:mrdocs:

Wrapper that overrides the GetParams() function of a stream.

== Synopsis

Declared in `<serialize.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename SubStream,
    typename Params>
class ParamsStream;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:ParamsStream-02/2constructor-01.adoc[`ParamsStream`]         [.small]#[constructor]#
| Constructors
| xref:ParamsStream-02/GetParams.adoc[`GetParams`] 
| Get reference to stream parameters.
| xref:ParamsStream-02/GetStream-06.adoc[`GetStream`] 
| `GetStream` overloads
| xref:ParamsStream-02/empty.adoc[`empty`] 
| Return whether the underlying stream is empty.
| xref:ParamsStream-02/ignore.adoc[`ignore`] 
| Skip the given number of bytes in the underlying stream.
| xref:ParamsStream-02/operator_rshift.adoc[`operator>>`] 
| Unserialize an object through this stream.
| xref:ParamsStream-02/read.adoc[`read`] 
| Read bytes from the underlying stream.
| xref:ParamsStream-02/size.adoc[`size`] 
| Return the number of bytes available in the underlying stream.
| xref:ParamsStream-02/write.adoc[`write`] 
| Write bytes to the underlying stream.
| xref:ParamsStream-02/operator_lshift.adoc[`operator<<`] 
| Serialize an object through this stream.
|===


== Deduction Guides

[cols="1,4"]
|===
| Name| Description
| xref:ParamsStream-00.adoc[`ParamsStream<Substream, Params>`] 
| Explicit template deduction guide is required for single‐parameter constructor so Substream&& is treated as a forwarding reference, and SubStream is deduced as reference type for lvalue arguments.
| xref:ParamsStream-0f.adoc[`ParamsStream<decltype(ParamsStream{std::forward<Substream>(s), params2, params...}), Params1>`] 
| Template deduction guide for multiple params arguments that creates a nested ParamsStream.
|===



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