[#llvm-ProfOStream]
= xref:llvm.adoc[llvm]::ProfOStream
:relfileprefix: ../
:mrdocs:

Profile writer stream that supports deferred byte‐level back‐patching.

== Synopsis

Declared in `<llvm/ProfileData/InstrProf.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ProfOStream;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ProfOStream/2constructor-05.adoc[`ProfOStream`]         [.small]#[constructor]#
| Constructors
| xref:llvm/ProfOStream/patch.adoc[`patch`] 
| Apply deferred patches after all data has been written and flushed.
| xref:llvm/ProfOStream/tell.adoc[`tell`] 
| Return the current write offset in bytes.
| xref:llvm/ProfOStream/write.adoc[`write`] 
| Write a 64‐bit value in the stream's endianness.
| xref:llvm/ProfOStream/write32.adoc[`write32`] 
| Write a 32‐bit value in the stream's endianness.
| xref:llvm/ProfOStream/writeByte.adoc[`writeByte`] 
| Write a single byte.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:llvm/ProfOStream/IsFDOStream.adoc[`IsFDOStream`] 
| True when `OS` is a `raw_fd_ostream;` otherwise it is a string stream.
| xref:llvm/ProfOStream/LE.adoc[`LE`] 
| Endian‐aware writer used for multi‐byte stores.
| xref:llvm/ProfOStream/OS.adoc[`OS`] 
| Underlying output stream being written.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/writeMemProf.adoc[`writeMemProf`]
| Write MemProf profile data to `OS` in the requested indexed format version.
|===


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