[#BloombergLP-ball-RecordStringFormatter]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::RecordStringFormatter
:relfileprefix: ../../
:mrdocs:

This class provides a value‐semantic log record formatter that holds a `printf`‐style format specification and a timestamp offset.

== Synopsis

Declared in `<ball_recordstringformatter.h>`

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

== Description

The overloaded `operator()` provided by the class formats a given record according to the format specification and outputs the formatted result to a given stream. The timestamp offset of the record formatter is added to each timestamp that is output to the stream.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/RecordStringFormatter/allocator_type.adoc[`allocator_type`] 
| This `typedef` is an alias for the allocator used by this object.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/RecordStringFormatter/2constructor-0e5.adoc[`RecordStringFormatter`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/ball/RecordStringFormatter/operator_assign.adoc[`operator=`] 
| Assign to this record formatter the value of the specified `rhs`.
| xref:BloombergLP/ball/RecordStringFormatter/disablePublishInLocalTime.adoc[`disablePublishInLocalTime`] 
| Disable adjustment of timestamps to the current local time.
| xref:BloombergLP/ball/RecordStringFormatter/enablePublishInLocalTime.adoc[`enablePublishInLocalTime`] 
| Enable adjustment of the timestamp attribute to the current local time. This method has no effect if adjustment to the current local time is already enabled.
| xref:BloombergLP/ball/RecordStringFormatter/format.adoc[`format`] 
| Return the format specification of this record formatter.
| xref:BloombergLP/ball/RecordStringFormatter/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/ball/RecordStringFormatter/isPublishInLocalTimeEnabled.adoc[`isPublishInLocalTimeEnabled`] 
| Return `true` if this formatter adjusts the timestamp attribute to the current local time, and `false` otherwise.
| xref:BloombergLP/ball/RecordStringFormatter/operator_call.adoc[`operator()`] 
| Format `record` to `stream` using this formatter's format specification.
| xref:BloombergLP/ball/RecordStringFormatter/setFormat.adoc[`setFormat`] 
| Set the format specification of this record formatter to `format`.
| xref:BloombergLP/ball/RecordStringFormatter/setTimestampOffset.adoc[`setTimestampOffset`] 
| Set the timestamp offset of this record formatter to `offset`.
| xref:BloombergLP/ball/RecordStringFormatter/timestampOffset.adoc[`timestampOffset`] 
| Return a reference to the non‐modifiable timestamp offset of this record formatter.
| xref:BloombergLP/ball/RecordStringFormatter/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<RecordStringFormatter, UsesBslmaAllocator>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/RecordStringFormatter/loadTextSchemeFormatter.adoc[`loadTextSchemeFormatter`] 
| Configure a "text" scheme formatter and load it into `output`.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/RecordStringFormatter/k_BASIC_ATTRIBUTE_FORMAT.adoc[`k_BASIC_ATTRIBUTE_FORMAT`] 
| A simple standard record format that renders `ball::Attribute` values.
| xref:BloombergLP/ball/RecordStringFormatter/k_DEFAULT_FORMAT.adoc[`k_DEFAULT_FORMAT`] 
| The default log format specification used by `RecordStringFormatter`.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/operator_not_eq-065.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/ball/operator_eq-00d.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value.
|===


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