[#bsl-basic_osyncstream]
= xref:bsl.adoc[bsl]::basic_osyncstream
:relfileprefix: ../
:mrdocs:

Forward declaration of `basic_osyncstream`.

== Synopsis

Declared in `<bslstl_osyncstream.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class CHAR_TYPE,
    class CHAR_TRAITS = char_traits<CHAR_TYPE>,
    class ALLOCATOR = xref:bsl/allocator-0df.adoc[allocator<CHAR_TYPE>]>
class basic_osyncstream
    : public std::basic_ostream<CHAR_TYPE, CHAR_TRAITS>
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `std::basic_ostream<CHAR_TYPE, CHAR_TRAITS>`
| Template class basic_ostream.
|===

== Types

[cols="1,4"]
|===
| Name| Description
| xref:bsl/basic_osyncstream/sentry.adoc[`sentry`] 
| Performs setup work for output streams.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/basic_osyncstream/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this stream.
| xref:bsl/basic_osyncstream/char_type.adoc[`char_type`] 
| Character type manipulated by this stream.
| xref:bsl/basic_osyncstream/int_type.adoc[`int_type`] 
| Integer type returned by stream operations.
| xref:bsl/basic_osyncstream/off_type.adoc[`off_type`] 
| Offset type used by the character traits.
| xref:bsl/basic_osyncstream/pos_type.adoc[`pos_type`] 
| Position type used by the character traits.
| xref:bsl/basic_osyncstream/streambuf_type.adoc[`streambuf_type`] 
| Stream buffer type wrapped by this stream's sync buffer.
| xref:bsl/basic_osyncstream/syncbuf_type.adoc[`syncbuf_type`] 
| Synchronized stream buffer type used by this output stream.
| xref:bsl/basic_osyncstream/traits_type.adoc[`traits_type`] 
| Character traits type used by this stream.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/basic_osyncstream/2constructor-08.adoc[`basic_osyncstream`]         [.small]#[constructor]#
| Constructors
| xref:bsl/basic_osyncstream/operator_assign.adoc[`operator=`] 
| Transfer the associated output to the wrapped stream buffer then assign to this object the value of the specified `original`, and return a reference providing modifiable access to this object. The contents of `original` are move‐assigned to this object. `original.get_wrapped() == nullptr` after the call.
| xref:bsl/basic_osyncstream/emit.adoc[`emit`] 
| Atomically transfer any characters buffered by this object to the wrapped stream buffer, so that it appears in the output stream as a contiguous sequence of characters. If an error occurs, set the `badbit` of the `rdstate` to `true`.
| xref:bsl/basic_osyncstream/get_allocator.adoc[`get_allocator`] 
| Return the allocator used to supply memory.
| xref:bsl/basic_osyncstream/get_wrapped.adoc[`get_wrapped`] 
| Return the wrapped buffer.
| xref:bsl/basic_osyncstream/rdbuf.adoc[`rdbuf`] 
| Return an address providing modifiable access to the `basic_syncbuf` object that is internally used by this stream object to buffer unformatted characters.
|===



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