[#BloombergLP-bslfmt-PadUtil-pad-0d]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::xref:BloombergLP/bslfmt/PadUtil.adoc[PadUtil]::pad
:relfileprefix: ../../../
:mrdocs:

`pad` overloads

== Synopses

Declared in `<bslfmt_padutil.h>`

Write `padWidth` copies of `filler` through the specified output iterator. Write `padWidth` copies of the specified single‐character `filler`. Write `padWidth` copies of the specified single‐character `filler`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_ITERATOR>
static
t_ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-07.adoc[pad](
    t_ITERATOR out,
    std::ptrdiff_t padWidth,
    char filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-07.adoc[_» more..._]#

Write `padWidth` copies of the specified single wide‐character `filler`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_ITERATOR>
static
t_ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-02c.adoc[pad](
    t_ITERATOR out,
    std::ptrdiff_t padWidth,
    wchar_t filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-02c.adoc[_» more..._]#

Write the specified `filler` (possibly a multi‐byte unicode sequence) to the specified `out` the specified `padWidth` times and return the new output iterator. If `padWidth < 0`, no output is done. The behavior is undefined unless the character type of `filler` is the same as `t_CHAR` or `filler` is entirely ascii. Note that the overloads that input a single character have an advantage over `bsl::fill_n` in that they will automatically widen or narrow the input character to `t_CHAR` if necessary.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_ITERATOR>
static
t_ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-01.adoc[pad](
    t_ITERATOR out,
    std::ptrdiff_t padWidth,
    std::string_view const& filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-01.adoc[_» more..._]#

Same as the preceding `pad` overload, for wide string fillers.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_ITERATOR>
static
t_ITERATOR
xref:BloombergLP/bslfmt/PadUtil/pad-020.adoc[pad](
    t_ITERATOR out,
    std::ptrdiff_t padWidth,
    std::wstring_view const& filler);
----

[.small]#xref:BloombergLP/bslfmt/PadUtil/pad-020.adoc[_» more..._]#


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