[#BloombergLP-bdlb-StringRefUtil-rtrim]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::xref:BloombergLP/bdlb/StringRefUtil.adoc[StringRefUtil]::rtrim
:relfileprefix: ../../../
:mrdocs:

Return a string reference with trailing whitespace removed.

== Synopsis

Declared in `<bdlb_stringrefutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
xref:BloombergLP/bslstl/StringRef.adoc[bslstl::StringRef]
rtrim(xref:BloombergLP/bslstl/StringRef.adoc[bslstl::StringRef] const& string);
----

== Description

Return a `bslstl::StringRef` object referring to the substring of (the referent data of) the specified `string` that excludes all trailing whitespace. See {Whitespace Character Specification}. If `string` consists entirely of whitespace, return a zero‐length reference to the beginning of (the referent data of) `string` (i.e., `bslstl::StringRef(string.data(), 0)`).

== Return Value

string reference with trailing whitespace removed

== Parameters

[cols="1,4"]
|===
| Name| Description
| *string*
| string whose trailing whitespace is trimmed
|===


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