1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template basic_string_literal</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../index.html" title="Chapter 1. Boost.Log v2"> 8<link rel="up" href="../../utilities.html#header.boost.log.utility.string_literal_fwd_hpp" title="Header <boost/log/utility/string_literal_fwd.hpp>"> 9<link rel="prev" href="str_literal.html" title="Function template str_literal"> 10<link rel="next" href="native_date_time_types.html" title="Type definition native_date_time_types"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td></tr></table> 14<hr> 15<div class="spirit-nav"> 16<a accesskey="p" href="str_literal.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.string_literal_fwd_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_date_time_types.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 17</div> 18<div class="refentry"> 19<a name="boost.log.basic_string_literal"></a><div class="titlepage"></div> 20<div class="refnamediv"> 21<h2><span class="refentrytitle">Class template basic_string_literal</span></h2> 22<p>boost::log::basic_string_literal — String literal wrapper. </p> 23</div> 24<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 25<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../utilities.html#header.boost.log.utility.string_literal_fwd_hpp" title="Header <boost/log/utility/string_literal_fwd.hpp>">boost/log/utility/string_literal_fwd.hpp</a>> 26 27</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> TraitsT<span class="special">></span> 28<span class="keyword">class</span> <a class="link" href="basic_string_literal.html" title="Class template basic_string_literal">basic_string_literal</a> <span class="special">{</span> 29<span class="keyword">public</span><span class="special">:</span> 30 <span class="comment">// <a class="link" href="basic_string_literal.html#boost.log.basic_string_literalconstruct-copy-destruct">construct/copy/destruct</a></span> 31 <a class="link" href="basic_string_literal.html#idm46079572628624-bb"><span class="identifier">basic_string_literal</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 32 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">size_type</span> LenV<span class="special">></span> <a class="link" href="basic_string_literal.html#idm46079572626496-bb"><span class="identifier">basic_string_literal</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&</span><span class="special">)</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 33 <a class="link" href="basic_string_literal.html#idm46079572621520-bb"><span class="identifier">basic_string_literal</span></a><span class="special">(</span><a class="link" href="basic_string_literal.html" title="Class template basic_string_literal">basic_string_literal</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 34 <span class="keyword">constexpr</span> this_type <span class="special">&</span> <a class="link" href="basic_string_literal.html#idm46079572617984-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 35 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">size_type</span> LenV<span class="special">></span> 36 <span class="keyword">constexpr</span> this_type <span class="special">&</span> <a class="link" href="basic_string_literal.html#idm46079572613712-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&</span><span class="special">)</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 37 38 <span class="comment">// <a class="link" href="basic_string_literal.html#idm46079572805632-bb">public member functions</a></span> 39 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572805072-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 40 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572800496-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 41 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572796144-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 42 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572791856-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 43 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572787280-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 44 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572782928-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 45 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572778640-bb"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 46 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572774048-bb"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 47 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572769680-bb"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 48 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572765376-bb"><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 49 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572760784-bb"><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 50 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572756416-bb"><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 51 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572752112-bb"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 52 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572747520-bb"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 53 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572743152-bb"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 54 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572738848-bb"><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 55 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572734256-bb"><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 56 <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572729888-bb"><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 57 <span class="keyword">constexpr</span> <span class="identifier">const_reference</span> <a class="link" href="basic_string_literal.html#idm46079572725584-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 58 <span class="identifier">const_reference</span> <a class="link" href="basic_string_literal.html#idm46079572721152-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 59 <span class="keyword">constexpr</span> <span class="identifier">const_pointer</span> <a class="link" href="basic_string_literal.html#idm46079572715952-bb"><span class="identifier">c_str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 60 <span class="keyword">constexpr</span> <span class="identifier">const_pointer</span> <a class="link" href="basic_string_literal.html#idm46079572713808-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 61 <span class="keyword">constexpr</span> <span class="identifier">size_type</span> <a class="link" href="basic_string_literal.html#idm46079572711664-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 62 <span class="keyword">constexpr</span> <span class="identifier">size_type</span> <a class="link" href="basic_string_literal.html#idm46079572709552-bb"><span class="identifier">length</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 63 <span class="keyword">constexpr</span> <span class="keyword">bool</span> <a class="link" href="basic_string_literal.html#idm46079572707440-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 64 <span class="keyword">constexpr</span> <span class="identifier">const_iterator</span> <a class="link" href="basic_string_literal.html#idm46079572704576-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 65 <span class="keyword">constexpr</span> <span class="identifier">const_iterator</span> <a class="link" href="basic_string_literal.html#idm46079572702400-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 66 <span class="identifier">const_reverse_iterator</span> <a class="link" href="basic_string_literal.html#idm46079572700224-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 67 <span class="identifier">const_reverse_iterator</span> <a class="link" href="basic_string_literal.html#idm46079572698064-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 68 <span class="identifier">string_type</span> <a class="link" href="basic_string_literal.html#idm46079572695904-bb"><span class="identifier">str</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 69 <span class="keyword">constexpr</span> <span class="keyword">void</span> <a class="link" href="basic_string_literal.html#idm46079572693760-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 70 <span class="keyword">constexpr</span> <span class="keyword">void</span> <a class="link" href="basic_string_literal.html#idm46079572691056-bb"><span class="identifier">swap</span></a><span class="special">(</span>this_type <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 71 <span class="keyword">constexpr</span> this_type <span class="special">&</span> <a class="link" href="basic_string_literal.html#idm46079572688528-bb"><span class="identifier">assign</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 72 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">size_type</span> LenV<span class="special">></span> 73 <span class="keyword">constexpr</span> this_type <span class="special">&</span> <a class="link" href="basic_string_literal.html#idm46079572683968-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&</span><span class="special">)</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 74 <span class="identifier">size_type</span> <a class="link" href="basic_string_literal.html#idm46079572677984-bb"><span class="identifier">copy</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 75 <span class="keyword">int</span> <a class="link" href="basic_string_literal.html#idm46079572669264-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">const_pointer</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 76 <span class="keyword">int</span> <a class="link" href="basic_string_literal.html#idm46079572659168-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 77 <span class="keyword">int</span> <a class="link" href="basic_string_literal.html#idm46079572650624-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 78 <span class="keyword">int</span> <a class="link" href="basic_string_literal.html#idm46079572641840-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 79 <span class="keyword">int</span> <a class="link" href="basic_string_literal.html#idm46079572636528-bb"><span class="identifier">compare</span></a><span class="special">(</span><span class="identifier">const_pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 80 <span class="keyword">int</span> <a class="link" href="basic_string_literal.html#idm46079572632768-bb"><span class="identifier">compare</span></a><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> 81<span class="special">}</span><span class="special">;</span></pre></div> 82<div class="refsect1"> 83<a name="idm44984848828608"></a><h2>Description</h2> 84<p>The <code class="computeroutput"><a class="link" href="basic_string_literal.html" title="Class template basic_string_literal">basic_string_literal</a></code> is a thin wrapper around a constant string literal. It provides interface similar to STL strings, but because of read-only nature of string literals, lacks ability to modify string contents. However, <code class="computeroutput"><a class="link" href="basic_string_literal.html" title="Class template basic_string_literal">basic_string_literal</a></code> objects can be assigned to and cleared.</p> 85<p>The main advantage of this class comparing to other string classes is that it doesn't dynamically allocate memory and therefore is fast, thin and exception safe. </p> 86<div class="refsect2"> 87<a name="idm44984848824672"></a><h3> 88<a name="boost.log.basic_string_literalconstruct-copy-destruct"></a><code class="computeroutput">basic_string_literal</code> 89 public 90 construct/copy/destruct</h3> 91<div class="orderedlist"><ol class="orderedlist" type="1"> 92<li class="listitem"> 93<pre class="literallayout"><a name="idm46079572628624-bb"></a><span class="identifier">basic_string_literal</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 94<p>Constructor</p> 95<p> 96</p> 97<div class="variablelist"><table border="0" class="variablelist compact"> 98<colgroup> 99<col align="left" valign="top"> 100<col> 101</colgroup> 102<tbody><tr> 103<td><p><span class="term">Postconditions:</span></p></td> 104<td><p><code class="computeroutput">empty() == true</code> </p></td> 105</tr></tbody> 106</table></div> 107</li> 108<li class="listitem"> 109<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">size_type</span> LenV<span class="special">></span> <a name="idm46079572626496-bb"></a><span class="identifier">basic_string_literal</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&</span><span class="special">)</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 110<p>Constructor from a string literal</p> 111<p> 112 113</p> 114<div class="variablelist"><table border="0" class="variablelist compact"> 115<colgroup> 116<col align="left" valign="top"> 117<col> 118</colgroup> 119<tbody> 120<tr> 121<td><p><span class="term">Parameters:</span></p></td> 122<td><div class="variablelist"><table border="0" class="variablelist compact"> 123<colgroup> 124<col align="left" valign="top"> 125<col> 126</colgroup> 127<tbody><tr> 128<td><p><span class="term"><code class="computeroutput">p</code></span></p></td> 129<td><p>A zero-terminated constant sequence of characters </p></td> 130</tr></tbody> 131</table></div></td> 132</tr> 133<tr> 134<td><p><span class="term">Postconditions:</span></p></td> 135<td><p><code class="computeroutput">*this == p</code> </p></td> 136</tr> 137</tbody> 138</table></div> 139</li> 140<li class="listitem"> 141<pre class="literallayout"><a name="idm46079572621520-bb"></a><span class="identifier">basic_string_literal</span><span class="special">(</span><a class="link" href="basic_string_literal.html" title="Class template basic_string_literal">basic_string_literal</a> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 142<p>Copy constructor</p> 143<p> 144 145</p> 146<div class="variablelist"><table border="0" class="variablelist compact"> 147<colgroup> 148<col align="left" valign="top"> 149<col> 150</colgroup> 151<tbody> 152<tr> 153<td><p><span class="term">Parameters:</span></p></td> 154<td><div class="variablelist"><table border="0" class="variablelist compact"> 155<colgroup> 156<col align="left" valign="top"> 157<col> 158</colgroup> 159<tbody><tr> 160<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 161<td><p>Source literal to copy string from </p></td> 162</tr></tbody> 163</table></div></td> 164</tr> 165<tr> 166<td><p><span class="term">Postconditions:</span></p></td> 167<td><p><code class="computeroutput">*this == that</code> </p></td> 168</tr> 169</tbody> 170</table></div> 171</li> 172<li class="listitem"> 173<pre class="literallayout"><span class="keyword">constexpr</span> this_type <span class="special">&</span> <a name="idm46079572617984-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 174<p>Assignment operator</p> 175<p> 176 177</p> 178<div class="variablelist"><table border="0" class="variablelist compact"> 179<colgroup> 180<col align="left" valign="top"> 181<col> 182</colgroup> 183<tbody> 184<tr> 185<td><p><span class="term">Parameters:</span></p></td> 186<td><div class="variablelist"><table border="0" class="variablelist compact"> 187<colgroup> 188<col align="left" valign="top"> 189<col> 190</colgroup> 191<tbody><tr> 192<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 193<td><p>Source literal to copy string from </p></td> 194</tr></tbody> 195</table></div></td> 196</tr> 197<tr> 198<td><p><span class="term">Postconditions:</span></p></td> 199<td><p><code class="computeroutput">*this == that</code> </p></td> 200</tr> 201</tbody> 202</table></div> 203</li> 204<li class="listitem"> 205<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">size_type</span> LenV<span class="special">></span> 206 <span class="keyword">constexpr</span> this_type <span class="special">&</span> <a name="idm46079572613712-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&</span><span class="special">)</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 207<p>Assignment from a string literal</p> 208<p> 209 210</p> 211<div class="variablelist"><table border="0" class="variablelist compact"> 212<colgroup> 213<col align="left" valign="top"> 214<col> 215</colgroup> 216<tbody> 217<tr> 218<td><p><span class="term">Parameters:</span></p></td> 219<td><div class="variablelist"><table border="0" class="variablelist compact"> 220<colgroup> 221<col align="left" valign="top"> 222<col> 223</colgroup> 224<tbody><tr> 225<td><p><span class="term"><code class="computeroutput">p</code></span></p></td> 226<td><p>A zero-terminated constant sequence of characters </p></td> 227</tr></tbody> 228</table></div></td> 229</tr> 230<tr> 231<td><p><span class="term">Postconditions:</span></p></td> 232<td><p><code class="computeroutput">*this == p</code> </p></td> 233</tr> 234</tbody> 235</table></div> 236</li> 237</ol></div> 238</div> 239<div class="refsect2"> 240<a name="idm44984848758912"></a><h3> 241<a name="idm46079572805632-bb"></a><code class="computeroutput">basic_string_literal</code> public member functions</h3> 242<div class="orderedlist"><ol class="orderedlist" type="1"> 243<li class="listitem"> 244<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572805072-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 245<p>Lexicographical comparison (equality)</p> 246<p> 247 248</p> 249<div class="variablelist"><table border="0" class="variablelist compact"> 250<colgroup> 251<col align="left" valign="top"> 252<col> 253</colgroup> 254<tbody> 255<tr> 256<td><p><span class="term">Parameters:</span></p></td> 257<td><div class="variablelist"><table border="0" class="variablelist compact"> 258<colgroup> 259<col align="left" valign="top"> 260<col> 261</colgroup> 262<tbody><tr> 263<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 264<td><p>Comparand </p></td> 265</tr></tbody> 266</table></div></td> 267</tr> 268<tr> 269<td><p><span class="term">Returns:</span></p></td> 270<td><p><code class="computeroutput">true</code> if the comparand string equals to this string, <code class="computeroutput">false</code> otherwise </p></td> 271</tr> 272</tbody> 273</table></div> 274</li> 275<li class="listitem"> 276<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572800496-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 277<p>Lexicographical comparison (equality)</p> 278<p> 279 280</p> 281<div class="variablelist"><table border="0" class="variablelist compact"> 282<colgroup> 283<col align="left" valign="top"> 284<col> 285</colgroup> 286<tbody> 287<tr> 288<td><p><span class="term">Parameters:</span></p></td> 289<td><div class="variablelist"><table border="0" class="variablelist compact"> 290<colgroup> 291<col align="left" valign="top"> 292<col> 293</colgroup> 294<tbody><tr> 295<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 296<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 297</tr></tbody> 298</table></div></td> 299</tr> 300<tr> 301<td><p><span class="term">Returns:</span></p></td> 302<td><p><code class="computeroutput">true</code> if the comparand string equals to this string, <code class="computeroutput">false</code> otherwise </p></td> 303</tr> 304</tbody> 305</table></div> 306</li> 307<li class="listitem"> 308<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572796144-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 309<p>Lexicographical comparison (equality)</p> 310<p> 311 312</p> 313<div class="variablelist"><table border="0" class="variablelist compact"> 314<colgroup> 315<col align="left" valign="top"> 316<col> 317</colgroup> 318<tbody> 319<tr> 320<td><p><span class="term">Parameters:</span></p></td> 321<td><div class="variablelist"><table border="0" class="variablelist compact"> 322<colgroup> 323<col align="left" valign="top"> 324<col> 325</colgroup> 326<tbody><tr> 327<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 328<td><p>Comparand </p></td> 329</tr></tbody> 330</table></div></td> 331</tr> 332<tr> 333<td><p><span class="term">Returns:</span></p></td> 334<td><p><code class="computeroutput">true</code> if the comparand string equals to this string, <code class="computeroutput">false</code> otherwise </p></td> 335</tr> 336</tbody> 337</table></div> 338</li> 339<li class="listitem"> 340<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572791856-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 341<p>Lexicographical comparison (inequality)</p> 342<p> 343 344</p> 345<div class="variablelist"><table border="0" class="variablelist compact"> 346<colgroup> 347<col align="left" valign="top"> 348<col> 349</colgroup> 350<tbody> 351<tr> 352<td><p><span class="term">Parameters:</span></p></td> 353<td><div class="variablelist"><table border="0" class="variablelist compact"> 354<colgroup> 355<col align="left" valign="top"> 356<col> 357</colgroup> 358<tbody><tr> 359<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 360<td><p>Comparand </p></td> 361</tr></tbody> 362</table></div></td> 363</tr> 364<tr> 365<td><p><span class="term">Returns:</span></p></td> 366<td><p><code class="computeroutput">true</code> if the comparand string is not equal to this string, <code class="computeroutput">false</code> otherwise </p></td> 367</tr> 368</tbody> 369</table></div> 370</li> 371<li class="listitem"> 372<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572787280-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 373<p>Lexicographical comparison (inequality)</p> 374<p> 375 376</p> 377<div class="variablelist"><table border="0" class="variablelist compact"> 378<colgroup> 379<col align="left" valign="top"> 380<col> 381</colgroup> 382<tbody> 383<tr> 384<td><p><span class="term">Parameters:</span></p></td> 385<td><div class="variablelist"><table border="0" class="variablelist compact"> 386<colgroup> 387<col align="left" valign="top"> 388<col> 389</colgroup> 390<tbody><tr> 391<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 392<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 393</tr></tbody> 394</table></div></td> 395</tr> 396<tr> 397<td><p><span class="term">Returns:</span></p></td> 398<td><p><code class="computeroutput">true</code> if the comparand string is not equal to this string, <code class="computeroutput">false</code> otherwise </p></td> 399</tr> 400</tbody> 401</table></div> 402</li> 403<li class="listitem"> 404<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572782928-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 405<p>Lexicographical comparison (inequality)</p> 406<p> 407 408</p> 409<div class="variablelist"><table border="0" class="variablelist compact"> 410<colgroup> 411<col align="left" valign="top"> 412<col> 413</colgroup> 414<tbody> 415<tr> 416<td><p><span class="term">Parameters:</span></p></td> 417<td><div class="variablelist"><table border="0" class="variablelist compact"> 418<colgroup> 419<col align="left" valign="top"> 420<col> 421</colgroup> 422<tbody><tr> 423<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 424<td><p>Comparand </p></td> 425</tr></tbody> 426</table></div></td> 427</tr> 428<tr> 429<td><p><span class="term">Returns:</span></p></td> 430<td><p><code class="computeroutput">true</code> if the comparand string is not equal to this string, <code class="computeroutput">false</code> otherwise </p></td> 431</tr> 432</tbody> 433</table></div> 434</li> 435<li class="listitem"> 436<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572778640-bb"></a><span class="keyword">operator</span><span class="special"><</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 437<p>Lexicographical comparison (less ordering)</p> 438<p> 439 440</p> 441<div class="variablelist"><table border="0" class="variablelist compact"> 442<colgroup> 443<col align="left" valign="top"> 444<col> 445</colgroup> 446<tbody> 447<tr> 448<td><p><span class="term">Parameters:</span></p></td> 449<td><div class="variablelist"><table border="0" class="variablelist compact"> 450<colgroup> 451<col align="left" valign="top"> 452<col> 453</colgroup> 454<tbody><tr> 455<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 456<td><p>Comparand </p></td> 457</tr></tbody> 458</table></div></td> 459</tr> 460<tr> 461<td><p><span class="term">Returns:</span></p></td> 462<td><p><code class="computeroutput">true</code> if this string is less than the comparand, <code class="computeroutput">false</code> otherwise </p></td> 463</tr> 464</tbody> 465</table></div> 466</li> 467<li class="listitem"> 468<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572774048-bb"></a><span class="keyword">operator</span><span class="special"><</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 469<p>Lexicographical comparison (less ordering)</p> 470<p> 471 472</p> 473<div class="variablelist"><table border="0" class="variablelist compact"> 474<colgroup> 475<col align="left" valign="top"> 476<col> 477</colgroup> 478<tbody> 479<tr> 480<td><p><span class="term">Parameters:</span></p></td> 481<td><div class="variablelist"><table border="0" class="variablelist compact"> 482<colgroup> 483<col align="left" valign="top"> 484<col> 485</colgroup> 486<tbody><tr> 487<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 488<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 489</tr></tbody> 490</table></div></td> 491</tr> 492<tr> 493<td><p><span class="term">Returns:</span></p></td> 494<td><p><code class="computeroutput">true</code> if this string is less than the comparand, <code class="computeroutput">false</code> otherwise </p></td> 495</tr> 496</tbody> 497</table></div> 498</li> 499<li class="listitem"> 500<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572769680-bb"></a><span class="keyword">operator</span><span class="special"><</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 501<p>Lexicographical comparison (less ordering)</p> 502<p> 503 504</p> 505<div class="variablelist"><table border="0" class="variablelist compact"> 506<colgroup> 507<col align="left" valign="top"> 508<col> 509</colgroup> 510<tbody> 511<tr> 512<td><p><span class="term">Parameters:</span></p></td> 513<td><div class="variablelist"><table border="0" class="variablelist compact"> 514<colgroup> 515<col align="left" valign="top"> 516<col> 517</colgroup> 518<tbody><tr> 519<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 520<td><p>Comparand </p></td> 521</tr></tbody> 522</table></div></td> 523</tr> 524<tr> 525<td><p><span class="term">Returns:</span></p></td> 526<td><p><code class="computeroutput">true</code> if this string is less than the comparand, <code class="computeroutput">false</code> otherwise </p></td> 527</tr> 528</tbody> 529</table></div> 530</li> 531<li class="listitem"> 532<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572765376-bb"></a><span class="keyword">operator</span><span class="special"><=</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 533<p>Lexicographical comparison (less or equal ordering)</p> 534<p> 535 536</p> 537<div class="variablelist"><table border="0" class="variablelist compact"> 538<colgroup> 539<col align="left" valign="top"> 540<col> 541</colgroup> 542<tbody> 543<tr> 544<td><p><span class="term">Parameters:</span></p></td> 545<td><div class="variablelist"><table border="0" class="variablelist compact"> 546<colgroup> 547<col align="left" valign="top"> 548<col> 549</colgroup> 550<tbody><tr> 551<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 552<td><p>Comparand </p></td> 553</tr></tbody> 554</table></div></td> 555</tr> 556<tr> 557<td><p><span class="term">Returns:</span></p></td> 558<td><p><code class="computeroutput">true</code> if this string is less or equal to the comparand, <code class="computeroutput">false</code> otherwise </p></td> 559</tr> 560</tbody> 561</table></div> 562</li> 563<li class="listitem"> 564<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572760784-bb"></a><span class="keyword">operator</span><span class="special"><=</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 565<p>Lexicographical comparison (less or equal ordering)</p> 566<p> 567 568</p> 569<div class="variablelist"><table border="0" class="variablelist compact"> 570<colgroup> 571<col align="left" valign="top"> 572<col> 573</colgroup> 574<tbody> 575<tr> 576<td><p><span class="term">Parameters:</span></p></td> 577<td><div class="variablelist"><table border="0" class="variablelist compact"> 578<colgroup> 579<col align="left" valign="top"> 580<col> 581</colgroup> 582<tbody><tr> 583<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 584<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 585</tr></tbody> 586</table></div></td> 587</tr> 588<tr> 589<td><p><span class="term">Returns:</span></p></td> 590<td><p><code class="computeroutput">true</code> if this string is less or equal to the comparand, <code class="computeroutput">false</code> otherwise </p></td> 591</tr> 592</tbody> 593</table></div> 594</li> 595<li class="listitem"> 596<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572756416-bb"></a><span class="keyword">operator</span><span class="special"><=</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 597<p>Lexicographical comparison (less or equal ordering)</p> 598<p> 599 600</p> 601<div class="variablelist"><table border="0" class="variablelist compact"> 602<colgroup> 603<col align="left" valign="top"> 604<col> 605</colgroup> 606<tbody> 607<tr> 608<td><p><span class="term">Parameters:</span></p></td> 609<td><div class="variablelist"><table border="0" class="variablelist compact"> 610<colgroup> 611<col align="left" valign="top"> 612<col> 613</colgroup> 614<tbody><tr> 615<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 616<td><p>Comparand </p></td> 617</tr></tbody> 618</table></div></td> 619</tr> 620<tr> 621<td><p><span class="term">Returns:</span></p></td> 622<td><p><code class="computeroutput">true</code> if this string is less or equal to the comparand, <code class="computeroutput">false</code> otherwise </p></td> 623</tr> 624</tbody> 625</table></div> 626</li> 627<li class="listitem"> 628<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572752112-bb"></a><span class="keyword">operator</span><span class="special">></span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 629<p>Lexicographical comparison (greater ordering)</p> 630<p> 631 632</p> 633<div class="variablelist"><table border="0" class="variablelist compact"> 634<colgroup> 635<col align="left" valign="top"> 636<col> 637</colgroup> 638<tbody> 639<tr> 640<td><p><span class="term">Parameters:</span></p></td> 641<td><div class="variablelist"><table border="0" class="variablelist compact"> 642<colgroup> 643<col align="left" valign="top"> 644<col> 645</colgroup> 646<tbody><tr> 647<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 648<td><p>Comparand </p></td> 649</tr></tbody> 650</table></div></td> 651</tr> 652<tr> 653<td><p><span class="term">Returns:</span></p></td> 654<td><p><code class="computeroutput">true</code> if this string is greater than the comparand, <code class="computeroutput">false</code> otherwise </p></td> 655</tr> 656</tbody> 657</table></div> 658</li> 659<li class="listitem"> 660<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572747520-bb"></a><span class="keyword">operator</span><span class="special">></span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 661<p>Lexicographical comparison (greater ordering)</p> 662<p> 663 664</p> 665<div class="variablelist"><table border="0" class="variablelist compact"> 666<colgroup> 667<col align="left" valign="top"> 668<col> 669</colgroup> 670<tbody> 671<tr> 672<td><p><span class="term">Parameters:</span></p></td> 673<td><div class="variablelist"><table border="0" class="variablelist compact"> 674<colgroup> 675<col align="left" valign="top"> 676<col> 677</colgroup> 678<tbody><tr> 679<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 680<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 681</tr></tbody> 682</table></div></td> 683</tr> 684<tr> 685<td><p><span class="term">Returns:</span></p></td> 686<td><p><code class="computeroutput">true</code> if this string is greater than the comparand, <code class="computeroutput">false</code> otherwise </p></td> 687</tr> 688</tbody> 689</table></div> 690</li> 691<li class="listitem"> 692<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572743152-bb"></a><span class="keyword">operator</span><span class="special">></span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 693<p>Lexicographical comparison (greater ordering)</p> 694<p> 695 696</p> 697<div class="variablelist"><table border="0" class="variablelist compact"> 698<colgroup> 699<col align="left" valign="top"> 700<col> 701</colgroup> 702<tbody> 703<tr> 704<td><p><span class="term">Parameters:</span></p></td> 705<td><div class="variablelist"><table border="0" class="variablelist compact"> 706<colgroup> 707<col align="left" valign="top"> 708<col> 709</colgroup> 710<tbody><tr> 711<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 712<td><p>Comparand </p></td> 713</tr></tbody> 714</table></div></td> 715</tr> 716<tr> 717<td><p><span class="term">Returns:</span></p></td> 718<td><p><code class="computeroutput">true</code> if this string is greater than the comparand, <code class="computeroutput">false</code> otherwise </p></td> 719</tr> 720</tbody> 721</table></div> 722</li> 723<li class="listitem"> 724<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572738848-bb"></a><span class="keyword">operator</span><span class="special">>=</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 725<p>Lexicographical comparison (greater or equal ordering)</p> 726<p> 727 728</p> 729<div class="variablelist"><table border="0" class="variablelist compact"> 730<colgroup> 731<col align="left" valign="top"> 732<col> 733</colgroup> 734<tbody> 735<tr> 736<td><p><span class="term">Parameters:</span></p></td> 737<td><div class="variablelist"><table border="0" class="variablelist compact"> 738<colgroup> 739<col align="left" valign="top"> 740<col> 741</colgroup> 742<tbody><tr> 743<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 744<td><p>Comparand </p></td> 745</tr></tbody> 746</table></div></td> 747</tr> 748<tr> 749<td><p><span class="term">Returns:</span></p></td> 750<td><p><code class="computeroutput">true</code> if this string is greater or equal to the comparand, <code class="computeroutput">false</code> otherwise </p></td> 751</tr> 752</tbody> 753</table></div> 754</li> 755<li class="listitem"> 756<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572734256-bb"></a><span class="keyword">operator</span><span class="special">>=</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 757<p>Lexicographical comparison (greater or qual ordering)</p> 758<p> 759 760</p> 761<div class="variablelist"><table border="0" class="variablelist compact"> 762<colgroup> 763<col align="left" valign="top"> 764<col> 765</colgroup> 766<tbody> 767<tr> 768<td><p><span class="term">Parameters:</span></p></td> 769<td><div class="variablelist"><table border="0" class="variablelist compact"> 770<colgroup> 771<col align="left" valign="top"> 772<col> 773</colgroup> 774<tbody><tr> 775<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 776<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 777</tr></tbody> 778</table></div></td> 779</tr> 780<tr> 781<td><p><span class="term">Returns:</span></p></td> 782<td><p><code class="computeroutput">true</code> if this string is greater or equal to the comparand, <code class="computeroutput">false</code> otherwise </p></td> 783</tr> 784</tbody> 785</table></div> 786</li> 787<li class="listitem"> 788<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46079572729888-bb"></a><span class="keyword">operator</span><span class="special">>=</span><span class="special">(</span><span class="identifier">string_type</span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 789<p>Lexicographical comparison (greater or equal ordering)</p> 790<p> 791 792</p> 793<div class="variablelist"><table border="0" class="variablelist compact"> 794<colgroup> 795<col align="left" valign="top"> 796<col> 797</colgroup> 798<tbody> 799<tr> 800<td><p><span class="term">Parameters:</span></p></td> 801<td><div class="variablelist"><table border="0" class="variablelist compact"> 802<colgroup> 803<col align="left" valign="top"> 804<col> 805</colgroup> 806<tbody><tr> 807<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 808<td><p>Comparand </p></td> 809</tr></tbody> 810</table></div></td> 811</tr> 812<tr> 813<td><p><span class="term">Returns:</span></p></td> 814<td><p><code class="computeroutput">true</code> if this string is greater or equal to the comparand, <code class="computeroutput">false</code> otherwise </p></td> 815</tr> 816</tbody> 817</table></div> 818</li> 819<li class="listitem"> 820<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">const_reference</span> <a name="idm46079572725584-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 821<p>Subscript operator</p> 822<p> 823 824 825</p> 826<div class="variablelist"><table border="0" class="variablelist compact"> 827<colgroup> 828<col align="left" valign="top"> 829<col> 830</colgroup> 831<tbody> 832<tr> 833<td><p><span class="term">Parameters:</span></p></td> 834<td><div class="variablelist"><table border="0" class="variablelist compact"> 835<colgroup> 836<col align="left" valign="top"> 837<col> 838</colgroup> 839<tbody><tr> 840<td><p><span class="term"><code class="computeroutput">i</code></span></p></td> 841<td><p>Requested character index </p></td> 842</tr></tbody> 843</table></div></td> 844</tr> 845<tr> 846<td><p><span class="term">Requires:</span></p></td> 847<td><p><code class="computeroutput">i < size()</code> </p></td> 848</tr> 849<tr> 850<td><p><span class="term">Returns:</span></p></td> 851<td><p>Constant reference to the requested character </p></td> 852</tr> 853</tbody> 854</table></div> 855</li> 856<li class="listitem"> 857<pre class="literallayout"><span class="identifier">const_reference</span> <a name="idm46079572721152-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 858<p>Checked subscript</p> 859<p> 860 861<span class="bold"><strong>Throws:</strong></span> An <code class="computeroutput">std::exception</code>-based exception if index <span class="emphasis"><em>i</em></span> is out of string boundaries </p> 862<div class="variablelist"><table border="0" class="variablelist compact"> 863<colgroup> 864<col align="left" valign="top"> 865<col> 866</colgroup> 867<tbody> 868<tr> 869<td><p><span class="term">Parameters:</span></p></td> 870<td><div class="variablelist"><table border="0" class="variablelist compact"> 871<colgroup> 872<col align="left" valign="top"> 873<col> 874</colgroup> 875<tbody><tr> 876<td><p><span class="term"><code class="computeroutput">i</code></span></p></td> 877<td><p>Requested character index </p></td> 878</tr></tbody> 879</table></div></td> 880</tr> 881<tr> 882<td><p><span class="term">Returns:</span></p></td> 883<td><p>Constant reference to the requested character</p></td> 884</tr> 885</tbody> 886</table></div> 887</li> 888<li class="listitem"> 889<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">const_pointer</span> <a name="idm46079572715952-bb"></a><span class="identifier">c_str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 890<p> 891</p> 892<div class="variablelist"><table border="0" class="variablelist compact"> 893<colgroup> 894<col align="left" valign="top"> 895<col> 896</colgroup> 897<tbody><tr> 898<td><p><span class="term">Returns:</span></p></td> 899<td><p>Pointer to the beginning of the literal </p></td> 900</tr></tbody> 901</table></div> 902</li> 903<li class="listitem"> 904<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">const_pointer</span> <a name="idm46079572713808-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 905<p> 906</p> 907<div class="variablelist"><table border="0" class="variablelist compact"> 908<colgroup> 909<col align="left" valign="top"> 910<col> 911</colgroup> 912<tbody><tr> 913<td><p><span class="term">Returns:</span></p></td> 914<td><p>Pointer to the beginning of the literal </p></td> 915</tr></tbody> 916</table></div> 917</li> 918<li class="listitem"> 919<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">size_type</span> <a name="idm46079572711664-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 920<p> 921</p> 922<div class="variablelist"><table border="0" class="variablelist compact"> 923<colgroup> 924<col align="left" valign="top"> 925<col> 926</colgroup> 927<tbody><tr> 928<td><p><span class="term">Returns:</span></p></td> 929<td><p>Length of the literal </p></td> 930</tr></tbody> 931</table></div> 932</li> 933<li class="listitem"> 934<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">size_type</span> <a name="idm46079572709552-bb"></a><span class="identifier">length</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 935<p> 936</p> 937<div class="variablelist"><table border="0" class="variablelist compact"> 938<colgroup> 939<col align="left" valign="top"> 940<col> 941</colgroup> 942<tbody><tr> 943<td><p><span class="term">Returns:</span></p></td> 944<td><p>Length of the literal </p></td> 945</tr></tbody> 946</table></div> 947</li> 948<li class="listitem"> 949<pre class="literallayout"><span class="keyword">constexpr</span> <span class="keyword">bool</span> <a name="idm46079572707440-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 950<p> 951</p> 952<div class="variablelist"><table border="0" class="variablelist compact"> 953<colgroup> 954<col align="left" valign="top"> 955<col> 956</colgroup> 957<tbody><tr> 958<td><p><span class="term">Returns:</span></p></td> 959<td><p><code class="computeroutput">true</code> if the literal is an empty string, <code class="computeroutput">false</code> otherwise </p></td> 960</tr></tbody> 961</table></div> 962</li> 963<li class="listitem"> 964<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">const_iterator</span> <a name="idm46079572704576-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 965<p> 966</p> 967<div class="variablelist"><table border="0" class="variablelist compact"> 968<colgroup> 969<col align="left" valign="top"> 970<col> 971</colgroup> 972<tbody><tr> 973<td><p><span class="term">Returns:</span></p></td> 974<td><p>Iterator that points to the first character of the literal </p></td> 975</tr></tbody> 976</table></div> 977</li> 978<li class="listitem"> 979<pre class="literallayout"><span class="keyword">constexpr</span> <span class="identifier">const_iterator</span> <a name="idm46079572702400-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 980<p> 981</p> 982<div class="variablelist"><table border="0" class="variablelist compact"> 983<colgroup> 984<col align="left" valign="top"> 985<col> 986</colgroup> 987<tbody><tr> 988<td><p><span class="term">Returns:</span></p></td> 989<td><p>Iterator that points after the last character of the literal </p></td> 990</tr></tbody> 991</table></div> 992</li> 993<li class="listitem"> 994<pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm46079572700224-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 995<p> 996</p> 997<div class="variablelist"><table border="0" class="variablelist compact"> 998<colgroup> 999<col align="left" valign="top"> 1000<col> 1001</colgroup> 1002<tbody><tr> 1003<td><p><span class="term">Returns:</span></p></td> 1004<td><p>Reverse iterator that points to the last character of the literal </p></td> 1005</tr></tbody> 1006</table></div> 1007</li> 1008<li class="listitem"> 1009<pre class="literallayout"><span class="identifier">const_reverse_iterator</span> <a name="idm46079572698064-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1010<p> 1011</p> 1012<div class="variablelist"><table border="0" class="variablelist compact"> 1013<colgroup> 1014<col align="left" valign="top"> 1015<col> 1016</colgroup> 1017<tbody><tr> 1018<td><p><span class="term">Returns:</span></p></td> 1019<td><p>Reverse iterator that points before the first character of the literal </p></td> 1020</tr></tbody> 1021</table></div> 1022</li> 1023<li class="listitem"> 1024<pre class="literallayout"><span class="identifier">string_type</span> <a name="idm46079572695904-bb"></a><span class="identifier">str</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 1025<p> 1026</p> 1027<div class="variablelist"><table border="0" class="variablelist compact"> 1028<colgroup> 1029<col align="left" valign="top"> 1030<col> 1031</colgroup> 1032<tbody><tr> 1033<td><p><span class="term">Returns:</span></p></td> 1034<td><p>STL string constructed from the literal </p></td> 1035</tr></tbody> 1036</table></div> 1037</li> 1038<li class="listitem"> 1039<pre class="literallayout"><span class="keyword">constexpr</span> <span class="keyword">void</span> <a name="idm46079572693760-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1040<p>The method clears the literal</p> 1041<p> 1042</p> 1043<div class="variablelist"><table border="0" class="variablelist compact"> 1044<colgroup> 1045<col align="left" valign="top"> 1046<col> 1047</colgroup> 1048<tbody><tr> 1049<td><p><span class="term">Postconditions:</span></p></td> 1050<td><p><code class="computeroutput">empty() == true</code> </p></td> 1051</tr></tbody> 1052</table></div> 1053</li> 1054<li class="listitem"> 1055<pre class="literallayout"><span class="keyword">constexpr</span> <span class="keyword">void</span> <a name="idm46079572691056-bb"></a><span class="identifier">swap</span><span class="special">(</span>this_type <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1056<p>The method swaps two literals </p> 1057</li> 1058<li class="listitem"> 1059<pre class="literallayout"><span class="keyword">constexpr</span> this_type <span class="special">&</span> <a name="idm46079572688528-bb"></a><span class="identifier">assign</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1060<p>Assignment from another literal</p> 1061<p> 1062 1063</p> 1064<div class="variablelist"><table border="0" class="variablelist compact"> 1065<colgroup> 1066<col align="left" valign="top"> 1067<col> 1068</colgroup> 1069<tbody> 1070<tr> 1071<td><p><span class="term">Parameters:</span></p></td> 1072<td><div class="variablelist"><table border="0" class="variablelist compact"> 1073<colgroup> 1074<col align="left" valign="top"> 1075<col> 1076</colgroup> 1077<tbody><tr> 1078<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 1079<td><p>Source literal to copy string from </p></td> 1080</tr></tbody> 1081</table></div></td> 1082</tr> 1083<tr> 1084<td><p><span class="term">Postconditions:</span></p></td> 1085<td><p><code class="computeroutput">*this == that</code> </p></td> 1086</tr> 1087</tbody> 1088</table></div> 1089</li> 1090<li class="listitem"> 1091<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">size_type</span> LenV<span class="special">></span> 1092 <span class="keyword">constexpr</span> this_type <span class="special">&</span> <a name="idm46079572683968-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&</span><span class="special">)</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1093<p>Assignment from another literal</p> 1094<p> 1095 1096</p> 1097<div class="variablelist"><table border="0" class="variablelist compact"> 1098<colgroup> 1099<col align="left" valign="top"> 1100<col> 1101</colgroup> 1102<tbody> 1103<tr> 1104<td><p><span class="term">Parameters:</span></p></td> 1105<td><div class="variablelist"><table border="0" class="variablelist compact"> 1106<colgroup> 1107<col align="left" valign="top"> 1108<col> 1109</colgroup> 1110<tbody><tr> 1111<td><p><span class="term"><code class="computeroutput">p</code></span></p></td> 1112<td><p>A zero-terminated constant sequence of characters </p></td> 1113</tr></tbody> 1114</table></div></td> 1115</tr> 1116<tr> 1117<td><p><span class="term">Postconditions:</span></p></td> 1118<td><p><code class="computeroutput">*this == p</code> </p></td> 1119</tr> 1120</tbody> 1121</table></div> 1122</li> 1123<li class="listitem"> 1124<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm46079572677984-bb"></a><span class="identifier">copy</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">*</span> str<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">size_type</span> pos <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 1125<p>The method copies the literal or its portion to an external buffer</p> 1126<p> 1127 1128 1129<span class="bold"><strong>Throws:</strong></span> An <code class="computeroutput">std::exception</code>-based exception if <span class="emphasis"><em>pos</em></span> is out of range. </p> 1130<div class="variablelist"><table border="0" class="variablelist compact"> 1131<colgroup> 1132<col align="left" valign="top"> 1133<col> 1134</colgroup> 1135<tbody> 1136<tr> 1137<td><p><span class="term">Parameters:</span></p></td> 1138<td><div class="variablelist"><table border="0" class="variablelist compact"> 1139<colgroup> 1140<col align="left" valign="top"> 1141<col> 1142</colgroup> 1143<tbody> 1144<tr> 1145<td><p><span class="term"><code class="computeroutput">n</code></span></p></td> 1146<td><p>Maximum number of characters to copy </p></td> 1147</tr> 1148<tr> 1149<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td> 1150<td><p>Starting position to start copying from </p></td> 1151</tr> 1152<tr> 1153<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 1154<td><p>Pointer to the external buffer beginning. Must not be NULL. The buffer must have enough capacity to accommodate the requested number of characters. </p></td> 1155</tr> 1156</tbody> 1157</table></div></td> 1158</tr> 1159<tr> 1160<td><p><span class="term">Requires:</span></p></td> 1161<td><p><code class="computeroutput">pos <= size()</code> </p></td> 1162</tr> 1163<tr> 1164<td><p><span class="term">Returns:</span></p></td> 1165<td><p>Number of characters copied</p></td> 1166</tr> 1167</tbody> 1168</table></div> 1169</li> 1170<li class="listitem"> 1171<pre class="literallayout"><span class="keyword">int</span> <a name="idm46079572669264-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">size_type</span> pos<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">const_pointer</span> str<span class="special">,</span> <span class="identifier">size_type</span> len<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 1172<p>Lexicographically compares the argument string to a part of this string</p> 1173<p> 1174 1175 1176<span class="bold"><strong>Throws:</strong></span> An <code class="computeroutput">std::exception</code>-based exception if <span class="emphasis"><em>pos</em></span> is out of range. </p> 1177<div class="variablelist"><table border="0" class="variablelist compact"> 1178<colgroup> 1179<col align="left" valign="top"> 1180<col> 1181</colgroup> 1182<tbody> 1183<tr> 1184<td><p><span class="term">Parameters:</span></p></td> 1185<td><div class="variablelist"><table border="0" class="variablelist compact"> 1186<colgroup> 1187<col align="left" valign="top"> 1188<col> 1189</colgroup> 1190<tbody> 1191<tr> 1192<td><p><span class="term"><code class="computeroutput">len</code></span></p></td> 1193<td><p>Number of characters in the sequence <span class="emphasis"><em>str</em></span>. </p></td> 1194</tr> 1195<tr> 1196<td><p><span class="term"><code class="computeroutput">n</code></span></p></td> 1197<td><p>Length of the substring of this string to perform comparison to </p></td> 1198</tr> 1199<tr> 1200<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td> 1201<td><p>Starting position within this string to perform comparison to </p></td> 1202</tr> 1203<tr> 1204<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 1205<td><p>Comparand. Must point to a sequence of characters, must not be NULL. </p></td> 1206</tr> 1207</tbody> 1208</table></div></td> 1209</tr> 1210<tr> 1211<td><p><span class="term">Requires:</span></p></td> 1212<td><p><code class="computeroutput">pos <= size()</code> </p></td> 1213</tr> 1214<tr> 1215<td><p><span class="term">Returns:</span></p></td> 1216<td><p>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand.</p></td> 1217</tr> 1218</tbody> 1219</table></div> 1220</li> 1221<li class="listitem"> 1222<pre class="literallayout"><span class="keyword">int</span> <a name="idm46079572659168-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">size_type</span> pos<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1223<p>Lexicographically compares the argument string to a part of this string</p> 1224<p> 1225 1226 1227<span class="bold"><strong>Throws:</strong></span> An <code class="computeroutput">std::exception</code>-based exception if <span class="emphasis"><em>pos</em></span> is out of range. </p> 1228<div class="variablelist"><table border="0" class="variablelist compact"> 1229<colgroup> 1230<col align="left" valign="top"> 1231<col> 1232</colgroup> 1233<tbody> 1234<tr> 1235<td><p><span class="term">Parameters:</span></p></td> 1236<td><div class="variablelist"><table border="0" class="variablelist compact"> 1237<colgroup> 1238<col align="left" valign="top"> 1239<col> 1240</colgroup> 1241<tbody> 1242<tr> 1243<td><p><span class="term"><code class="computeroutput">n</code></span></p></td> 1244<td><p>Length of the substring of this string to perform comparison to </p></td> 1245</tr> 1246<tr> 1247<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td> 1248<td><p>Starting position within this string to perform comparison to </p></td> 1249</tr> 1250<tr> 1251<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 1252<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 1253</tr> 1254</tbody> 1255</table></div></td> 1256</tr> 1257<tr> 1258<td><p><span class="term">Requires:</span></p></td> 1259<td><p><code class="computeroutput">pos <= size()</code> </p></td> 1260</tr> 1261<tr> 1262<td><p><span class="term">Returns:</span></p></td> 1263<td><p>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand.</p></td> 1264</tr> 1265</tbody> 1266</table></div> 1267</li> 1268<li class="listitem"> 1269<pre class="literallayout"><span class="keyword">int</span> <a name="idm46079572650624-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">size_type</span> pos<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">,</span> this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1270<p>Lexicographically compares the argument string literal to a part of this string</p> 1271<p> 1272 1273 1274<span class="bold"><strong>Throws:</strong></span> An <code class="computeroutput">std::exception</code>-based exception if <span class="emphasis"><em>pos</em></span> is out of range. </p> 1275<div class="variablelist"><table border="0" class="variablelist compact"> 1276<colgroup> 1277<col align="left" valign="top"> 1278<col> 1279</colgroup> 1280<tbody> 1281<tr> 1282<td><p><span class="term">Parameters:</span></p></td> 1283<td><div class="variablelist"><table border="0" class="variablelist compact"> 1284<colgroup> 1285<col align="left" valign="top"> 1286<col> 1287</colgroup> 1288<tbody> 1289<tr> 1290<td><p><span class="term"><code class="computeroutput">n</code></span></p></td> 1291<td><p>Length of the substring of this string to perform comparison to </p></td> 1292</tr> 1293<tr> 1294<td><p><span class="term"><code class="computeroutput">pos</code></span></p></td> 1295<td><p>Starting position within this string to perform comparison to </p></td> 1296</tr> 1297<tr> 1298<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 1299<td><p>Comparand </p></td> 1300</tr> 1301</tbody> 1302</table></div></td> 1303</tr> 1304<tr> 1305<td><p><span class="term">Requires:</span></p></td> 1306<td><p><code class="computeroutput">pos <= size()</code> </p></td> 1307</tr> 1308<tr> 1309<td><p><span class="term">Returns:</span></p></td> 1310<td><p>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand.</p></td> 1311</tr> 1312</tbody> 1313</table></div> 1314</li> 1315<li class="listitem"> 1316<pre class="literallayout"><span class="keyword">int</span> <a name="idm46079572641840-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">,</span> <span class="identifier">size_type</span> len<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1317<p>Lexicographically compares the argument string to this string</p> 1318<p> 1319 1320</p> 1321<div class="variablelist"><table border="0" class="variablelist compact"> 1322<colgroup> 1323<col align="left" valign="top"> 1324<col> 1325</colgroup> 1326<tbody> 1327<tr> 1328<td><p><span class="term">Parameters:</span></p></td> 1329<td><div class="variablelist"><table border="0" class="variablelist compact"> 1330<colgroup> 1331<col align="left" valign="top"> 1332<col> 1333</colgroup> 1334<tbody> 1335<tr> 1336<td><p><span class="term"><code class="computeroutput">len</code></span></p></td> 1337<td><p>Number of characters in the sequence <span class="emphasis"><em>str</em></span>. </p></td> 1338</tr> 1339<tr> 1340<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 1341<td><p>Comparand. Must point to a sequence of characters, must not be NULL. </p></td> 1342</tr> 1343</tbody> 1344</table></div></td> 1345</tr> 1346<tr> 1347<td><p><span class="term">Returns:</span></p></td> 1348<td><p>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand. </p></td> 1349</tr> 1350</tbody> 1351</table></div> 1352</li> 1353<li class="listitem"> 1354<pre class="literallayout"><span class="keyword">int</span> <a name="idm46079572636528-bb"></a><span class="identifier">compare</span><span class="special">(</span><span class="identifier">const_pointer</span> str<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1355<p>Lexicographically compares the argument string to this string</p> 1356<p> 1357 1358</p> 1359<div class="variablelist"><table border="0" class="variablelist compact"> 1360<colgroup> 1361<col align="left" valign="top"> 1362<col> 1363</colgroup> 1364<tbody> 1365<tr> 1366<td><p><span class="term">Parameters:</span></p></td> 1367<td><div class="variablelist"><table border="0" class="variablelist compact"> 1368<colgroup> 1369<col align="left" valign="top"> 1370<col> 1371</colgroup> 1372<tbody><tr> 1373<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 1374<td><p>Comparand. Must point to a zero-terminated sequence of characters, must not be NULL. </p></td> 1375</tr></tbody> 1376</table></div></td> 1377</tr> 1378<tr> 1379<td><p><span class="term">Returns:</span></p></td> 1380<td><p>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand. </p></td> 1381</tr> 1382</tbody> 1383</table></div> 1384</li> 1385<li class="listitem"> 1386<pre class="literallayout"><span class="keyword">int</span> <a name="idm46079572632768-bb"></a><span class="identifier">compare</span><span class="special">(</span>this_type <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 1387<p>Lexicographically compares the argument string to this string</p> 1388<p> 1389 1390</p> 1391<div class="variablelist"><table border="0" class="variablelist compact"> 1392<colgroup> 1393<col align="left" valign="top"> 1394<col> 1395</colgroup> 1396<tbody> 1397<tr> 1398<td><p><span class="term">Parameters:</span></p></td> 1399<td><div class="variablelist"><table border="0" class="variablelist compact"> 1400<colgroup> 1401<col align="left" valign="top"> 1402<col> 1403</colgroup> 1404<tbody><tr> 1405<td><p><span class="term"><code class="computeroutput">that</code></span></p></td> 1406<td><p>Comparand </p></td> 1407</tr></tbody> 1408</table></div></td> 1409</tr> 1410<tr> 1411<td><p><span class="term">Returns:</span></p></td> 1412<td><p>Zero if the comparand equals this string, a negative value if this string is less than the comparand, a positive value if this string is greater than the comparand. </p></td> 1413</tr> 1414</tbody> 1415</table></div> 1416</li> 1417</ol></div> 1418</div> 1419</div> 1420</div> 1421<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 1422<td align="left"></td> 1423<td align="right"><div class="copyright-footer">Copyright © 2007-2019 Andrey Semashev<p> 1424 Distributed under the Boost Software License, Version 1.0. (See accompanying 1425 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). 1426 </p> 1427</div></td> 1428</tr></table> 1429<hr> 1430<div class="spirit-nav"> 1431<a accesskey="p" href="str_literal.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../utilities.html#header.boost.log.utility.string_literal_fwd_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="native_date_time_types.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 1432</div> 1433</body> 1434</html> 1435
