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