• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_static_string::subview</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="Boost.StaticString">
8<link rel="up" href="../boost__static_strings__basic_static_string.html" title="basic_static_string">
9<link rel="prev" href="substr.html" title="basic_static_string::substr">
10<link rel="next" href="copy.html" title="basic_static_string::copy">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="substr.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__static_strings__basic_static_string.html"><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="copy.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="static_string.ref.boost__static_strings__basic_static_string.subview"></a><a class="link" href="subview.html" title="basic_static_string::subview">basic_static_string::subview</a>
28</h4></div></div></div>
29<p>
30          <a class="indexterm" name="idm45714125843584"></a>
31        </p>
32<p>
33          Return a string view of a substring.
34        </p>
35<h6>
36<a name="static_string.ref.boost__static_strings__basic_static_string.subview.h0"></a>
37          <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.subview.synopsis"></a></span><a class="link" href="subview.html#static_string.ref.boost__static_strings__basic_static_string.subview.synopsis">Synopsis</a>
38        </h6>
39<pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">string_view_type</span>
40<span class="identifier">subview</span><span class="special">(</span>
41    <span class="identifier">size_type</span> <span class="identifier">pos</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
42    <span class="identifier">size_type</span> <span class="identifier">count</span> <span class="special">=</span> <a class="link" href="npos.html" title="basic_static_string::npos">npos</a><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
43</pre>
44<h6>
45<a name="static_string.ref.boost__static_strings__basic_static_string.subview.h1"></a>
46          <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.subview.description"></a></span><a class="link" href="subview.html#static_string.ref.boost__static_strings__basic_static_string.subview.description">Description</a>
47        </h6>
48<p>
49          Returns a view of a substring.
50        </p>
51<h6>
52<a name="static_string.ref.boost__static_strings__basic_static_string.subview.h2"></a>
53          <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.subview.exception_safety"></a></span><a class="link" href="subview.html#static_string.ref.boost__static_strings__basic_static_string.subview.exception_safety">Exception
54          Safety</a>
55        </h6>
56<p>
57          Strong guarantee.
58        </p>
59<h6>
60<a name="static_string.ref.boost__static_strings__basic_static_string.subview.h3"></a>
61          <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.subview.return_value"></a></span><a class="link" href="subview.html#static_string.ref.boost__static_strings__basic_static_string.subview.return_value">Return
62          Value</a>
63        </h6>
64<p>
65          A <code class="computeroutput"><span class="identifier">string_view_type</span></code> object
66          referring to {<a class="link" href="data/overload1.html" title="basic_static_string::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code></a>
67          + pos, std::min(count, <a class="link" href="size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>
68          - pos)).
69        </p>
70<h6>
71<a name="static_string.ref.boost__static_strings__basic_static_string.subview.h4"></a>
72          <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.subview.parameters"></a></span><a class="link" href="subview.html#static_string.ref.boost__static_strings__basic_static_string.subview.parameters">Parameters</a>
73        </h6>
74<div class="informaltable"><table class="table">
75<colgroup>
76<col>
77<col>
78</colgroup>
79<thead><tr>
80<th>
81                  <p>
82                    Name
83                  </p>
84                </th>
85<th>
86                  <p>
87                    Description
88                  </p>
89                </th>
90</tr></thead>
91<tbody>
92<tr>
93<td>
94                  <p>
95                    <code class="computeroutput"><span class="identifier">pos</span></code>
96                  </p>
97                </td>
98<td>
99                  <p>
100                    The index to being the substring at. The default arugment for
101                    this parameter is <code class="computeroutput"><span class="number">0</span></code>.
102                  </p>
103                </td>
104</tr>
105<tr>
106<td>
107                  <p>
108                    <code class="computeroutput"><span class="identifier">count</span></code>
109                  </p>
110                </td>
111<td>
112                  <p>
113                    The length of the substring. The default arugment for this parameter
114                    is <a class="link" href="npos.html" title="basic_static_string::npos"><code class="computeroutput"><span class="identifier">npos</span></code></a>.
115                  </p>
116                </td>
117</tr>
118</tbody>
119</table></div>
120<h6>
121<a name="static_string.ref.boost__static_strings__basic_static_string.subview.h5"></a>
122          <span class="phrase"><a name="static_string.ref.boost__static_strings__basic_static_string.subview.exceptions"></a></span><a class="link" href="subview.html#static_string.ref.boost__static_strings__basic_static_string.subview.exceptions">Exceptions</a>
123        </h6>
124<div class="informaltable"><table class="table">
125<colgroup>
126<col>
127<col>
128</colgroup>
129<thead><tr>
130<th>
131                  <p>
132                    Type
133                  </p>
134                </th>
135<th>
136                  <p>
137                    Thrown On
138                  </p>
139                </th>
140</tr></thead>
141<tbody><tr>
142<td>
143                  <p>
144                    <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">out_of_range</span></code>
145                  </p>
146                </td>
147<td>
148                  <p>
149                    pos &gt; <a class="link" href="size.html" title="basic_static_string::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>
150                  </p>
151                </td>
152</tr></tbody>
153</table></div>
154</div>
155<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
156<td align="left"></td>
157<td align="right"><div class="copyright-footer">Copyright © 2019, 2020 Krystian Stasiowski<br>Copyright © 2016-2019 Vinnie
158      Falco<p>
159        Distributed under the Boost Software License, Version 1.0. (See accompanying
160        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>)
161      </p>
162</div></td>
163</tr></table>
164<hr>
165<div class="spirit-nav">
166<a accesskey="p" href="substr.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__static_strings__basic_static_string.html"><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="copy.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
167</div>
168</body>
169</html>
170