<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="Source to the Rust file `src/libstd/ffi/c_str.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>c_str.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100"> 100</span>
<span id="101"> 101</span>
<span id="102"> 102</span>
<span id="103"> 103</span>
<span id="104"> 104</span>
<span id="105"> 105</span>
<span id="106"> 106</span>
<span id="107"> 107</span>
<span id="108"> 108</span>
<span id="109"> 109</span>
<span id="110"> 110</span>
<span id="111"> 111</span>
<span id="112"> 112</span>
<span id="113"> 113</span>
<span id="114"> 114</span>
<span id="115"> 115</span>
<span id="116"> 116</span>
<span id="117"> 117</span>
<span id="118"> 118</span>
<span id="119"> 119</span>
<span id="120"> 120</span>
<span id="121"> 121</span>
<span id="122"> 122</span>
<span id="123"> 123</span>
<span id="124"> 124</span>
<span id="125"> 125</span>
<span id="126"> 126</span>
<span id="127"> 127</span>
<span id="128"> 128</span>
<span id="129"> 129</span>
<span id="130"> 130</span>
<span id="131"> 131</span>
<span id="132"> 132</span>
<span id="133"> 133</span>
<span id="134"> 134</span>
<span id="135"> 135</span>
<span id="136"> 136</span>
<span id="137"> 137</span>
<span id="138"> 138</span>
<span id="139"> 139</span>
<span id="140"> 140</span>
<span id="141"> 141</span>
<span id="142"> 142</span>
<span id="143"> 143</span>
<span id="144"> 144</span>
<span id="145"> 145</span>
<span id="146"> 146</span>
<span id="147"> 147</span>
<span id="148"> 148</span>
<span id="149"> 149</span>
<span id="150"> 150</span>
<span id="151"> 151</span>
<span id="152"> 152</span>
<span id="153"> 153</span>
<span id="154"> 154</span>
<span id="155"> 155</span>
<span id="156"> 156</span>
<span id="157"> 157</span>
<span id="158"> 158</span>
<span id="159"> 159</span>
<span id="160"> 160</span>
<span id="161"> 161</span>
<span id="162"> 162</span>
<span id="163"> 163</span>
<span id="164"> 164</span>
<span id="165"> 165</span>
<span id="166"> 166</span>
<span id="167"> 167</span>
<span id="168"> 168</span>
<span id="169"> 169</span>
<span id="170"> 170</span>
<span id="171"> 171</span>
<span id="172"> 172</span>
<span id="173"> 173</span>
<span id="174"> 174</span>
<span id="175"> 175</span>
<span id="176"> 176</span>
<span id="177"> 177</span>
<span id="178"> 178</span>
<span id="179"> 179</span>
<span id="180"> 180</span>
<span id="181"> 181</span>
<span id="182"> 182</span>
<span id="183"> 183</span>
<span id="184"> 184</span>
<span id="185"> 185</span>
<span id="186"> 186</span>
<span id="187"> 187</span>
<span id="188"> 188</span>
<span id="189"> 189</span>
<span id="190"> 190</span>
<span id="191"> 191</span>
<span id="192"> 192</span>
<span id="193"> 193</span>
<span id="194"> 194</span>
<span id="195"> 195</span>
<span id="196"> 196</span>
<span id="197"> 197</span>
<span id="198"> 198</span>
<span id="199"> 199</span>
<span id="200"> 200</span>
<span id="201"> 201</span>
<span id="202"> 202</span>
<span id="203"> 203</span>
<span id="204"> 204</span>
<span id="205"> 205</span>
<span id="206"> 206</span>
<span id="207"> 207</span>
<span id="208"> 208</span>
<span id="209"> 209</span>
<span id="210"> 210</span>
<span id="211"> 211</span>
<span id="212"> 212</span>
<span id="213"> 213</span>
<span id="214"> 214</span>
<span id="215"> 215</span>
<span id="216"> 216</span>
<span id="217"> 217</span>
<span id="218"> 218</span>
<span id="219"> 219</span>
<span id="220"> 220</span>
<span id="221"> 221</span>
<span id="222"> 222</span>
<span id="223"> 223</span>
<span id="224"> 224</span>
<span id="225"> 225</span>
<span id="226"> 226</span>
<span id="227"> 227</span>
<span id="228"> 228</span>
<span id="229"> 229</span>
<span id="230"> 230</span>
<span id="231"> 231</span>
<span id="232"> 232</span>
<span id="233"> 233</span>
<span id="234"> 234</span>
<span id="235"> 235</span>
<span id="236"> 236</span>
<span id="237"> 237</span>
<span id="238"> 238</span>
<span id="239"> 239</span>
<span id="240"> 240</span>
<span id="241"> 241</span>
<span id="242"> 242</span>
<span id="243"> 243</span>
<span id="244"> 244</span>
<span id="245"> 245</span>
<span id="246"> 246</span>
<span id="247"> 247</span>
<span id="248"> 248</span>
<span id="249"> 249</span>
<span id="250"> 250</span>
<span id="251"> 251</span>
<span id="252"> 252</span>
<span id="253"> 253</span>
<span id="254"> 254</span>
<span id="255"> 255</span>
<span id="256"> 256</span>
<span id="257"> 257</span>
<span id="258"> 258</span>
<span id="259"> 259</span>
<span id="260"> 260</span>
<span id="261"> 261</span>
<span id="262"> 262</span>
<span id="263"> 263</span>
<span id="264"> 264</span>
<span id="265"> 265</span>
<span id="266"> 266</span>
<span id="267"> 267</span>
<span id="268"> 268</span>
<span id="269"> 269</span>
<span id="270"> 270</span>
<span id="271"> 271</span>
<span id="272"> 272</span>
<span id="273"> 273</span>
<span id="274"> 274</span>
<span id="275"> 275</span>
<span id="276"> 276</span>
<span id="277"> 277</span>
<span id="278"> 278</span>
<span id="279"> 279</span>
<span id="280"> 280</span>
<span id="281"> 281</span>
<span id="282"> 282</span>
<span id="283"> 283</span>
<span id="284"> 284</span>
<span id="285"> 285</span>
<span id="286"> 286</span>
<span id="287"> 287</span>
<span id="288"> 288</span>
<span id="289"> 289</span>
<span id="290"> 290</span>
<span id="291"> 291</span>
<span id="292"> 292</span>
<span id="293"> 293</span>
<span id="294"> 294</span>
<span id="295"> 295</span>
<span id="296"> 296</span>
<span id="297"> 297</span>
<span id="298"> 298</span>
<span id="299"> 299</span>
<span id="300"> 300</span>
<span id="301"> 301</span>
<span id="302"> 302</span>
<span id="303"> 303</span>
<span id="304"> 304</span>
<span id="305"> 305</span>
<span id="306"> 306</span>
<span id="307"> 307</span>
<span id="308"> 308</span>
<span id="309"> 309</span>
<span id="310"> 310</span>
<span id="311"> 311</span>
<span id="312"> 312</span>
<span id="313"> 313</span>
<span id="314"> 314</span>
<span id="315"> 315</span>
<span id="316"> 316</span>
<span id="317"> 317</span>
<span id="318"> 318</span>
<span id="319"> 319</span>
<span id="320"> 320</span>
<span id="321"> 321</span>
<span id="322"> 322</span>
<span id="323"> 323</span>
<span id="324"> 324</span>
<span id="325"> 325</span>
<span id="326"> 326</span>
<span id="327"> 327</span>
<span id="328"> 328</span>
<span id="329"> 329</span>
<span id="330"> 330</span>
<span id="331"> 331</span>
<span id="332"> 332</span>
<span id="333"> 333</span>
<span id="334"> 334</span>
<span id="335"> 335</span>
<span id="336"> 336</span>
<span id="337"> 337</span>
<span id="338"> 338</span>
<span id="339"> 339</span>
<span id="340"> 340</span>
<span id="341"> 341</span>
<span id="342"> 342</span>
<span id="343"> 343</span>
<span id="344"> 344</span>
<span id="345"> 345</span>
<span id="346"> 346</span>
<span id="347"> 347</span>
<span id="348"> 348</span>
<span id="349"> 349</span>
<span id="350"> 350</span>
<span id="351"> 351</span>
<span id="352"> 352</span>
<span id="353"> 353</span>
<span id="354"> 354</span>
<span id="355"> 355</span>
<span id="356"> 356</span>
<span id="357"> 357</span>
<span id="358"> 358</span>
<span id="359"> 359</span>
<span id="360"> 360</span>
<span id="361"> 361</span>
<span id="362"> 362</span>
<span id="363"> 363</span>
<span id="364"> 364</span>
<span id="365"> 365</span>
<span id="366"> 366</span>
<span id="367"> 367</span>
<span id="368"> 368</span>
<span id="369"> 369</span>
<span id="370"> 370</span>
<span id="371"> 371</span>
<span id="372"> 372</span>
<span id="373"> 373</span>
<span id="374"> 374</span>
<span id="375"> 375</span>
<span id="376"> 376</span>
<span id="377"> 377</span>
<span id="378"> 378</span>
<span id="379"> 379</span>
<span id="380"> 380</span>
<span id="381"> 381</span>
<span id="382"> 382</span>
<span id="383"> 383</span>
<span id="384"> 384</span>
<span id="385"> 385</span>
<span id="386"> 386</span>
<span id="387"> 387</span>
<span id="388"> 388</span>
<span id="389"> 389</span>
<span id="390"> 390</span>
<span id="391"> 391</span>
<span id="392"> 392</span>
<span id="393"> 393</span>
<span id="394"> 394</span>
<span id="395"> 395</span>
<span id="396"> 396</span>
<span id="397"> 397</span>
<span id="398"> 398</span>
<span id="399"> 399</span>
<span id="400"> 400</span>
<span id="401"> 401</span>
<span id="402"> 402</span>
<span id="403"> 403</span>
<span id="404"> 404</span>
<span id="405"> 405</span>
<span id="406"> 406</span>
<span id="407"> 407</span>
<span id="408"> 408</span>
<span id="409"> 409</span>
<span id="410"> 410</span>
<span id="411"> 411</span>
<span id="412"> 412</span>
<span id="413"> 413</span>
<span id="414"> 414</span>
<span id="415"> 415</span>
<span id="416"> 416</span>
<span id="417"> 417</span>
<span id="418"> 418</span>
<span id="419"> 419</span>
<span id="420"> 420</span>
<span id="421"> 421</span>
<span id="422"> 422</span>
<span id="423"> 423</span>
<span id="424"> 424</span>
<span id="425"> 425</span>
<span id="426"> 426</span>
<span id="427"> 427</span>
<span id="428"> 428</span>
<span id="429"> 429</span>
<span id="430"> 430</span>
<span id="431"> 431</span>
<span id="432"> 432</span>
<span id="433"> 433</span>
<span id="434"> 434</span>
<span id="435"> 435</span>
<span id="436"> 436</span>
<span id="437"> 437</span>
<span id="438"> 438</span>
<span id="439"> 439</span>
<span id="440"> 440</span>
<span id="441"> 441</span>
<span id="442"> 442</span>
<span id="443"> 443</span>
<span id="444"> 444</span>
<span id="445"> 445</span>
<span id="446"> 446</span>
<span id="447"> 447</span>
<span id="448"> 448</span>
<span id="449"> 449</span>
<span id="450"> 450</span>
<span id="451"> 451</span>
<span id="452"> 452</span>
<span id="453"> 453</span>
<span id="454"> 454</span>
<span id="455"> 455</span>
<span id="456"> 456</span>
<span id="457"> 457</span>
<span id="458"> 458</span>
<span id="459"> 459</span>
<span id="460"> 460</span>
<span id="461"> 461</span>
<span id="462"> 462</span>
<span id="463"> 463</span>
<span id="464"> 464</span>
<span id="465"> 465</span>
<span id="466"> 466</span>
<span id="467"> 467</span>
<span id="468"> 468</span>
<span id="469"> 469</span>
<span id="470"> 470</span>
<span id="471"> 471</span>
<span id="472"> 472</span>
<span id="473"> 473</span>
<span id="474"> 474</span>
<span id="475"> 475</span>
<span id="476"> 476</span>
<span id="477"> 477</span>
<span id="478"> 478</span>
<span id="479"> 479</span>
<span id="480"> 480</span>
<span id="481"> 481</span>
<span id="482"> 482</span>
<span id="483"> 483</span>
<span id="484"> 484</span>
<span id="485"> 485</span>
<span id="486"> 486</span>
<span id="487"> 487</span>
<span id="488"> 488</span>
<span id="489"> 489</span>
<span id="490"> 490</span>
<span id="491"> 491</span>
<span id="492"> 492</span>
<span id="493"> 493</span>
<span id="494"> 494</span>
<span id="495"> 495</span>
<span id="496"> 496</span>
<span id="497"> 497</span>
<span id="498"> 498</span>
<span id="499"> 499</span>
<span id="500"> 500</span>
<span id="501"> 501</span>
<span id="502"> 502</span>
<span id="503"> 503</span>
<span id="504"> 504</span>
<span id="505"> 505</span>
<span id="506"> 506</span>
<span id="507"> 507</span>
<span id="508"> 508</span>
<span id="509"> 509</span>
<span id="510"> 510</span>
<span id="511"> 511</span>
<span id="512"> 512</span>
<span id="513"> 513</span>
<span id="514"> 514</span>
<span id="515"> 515</span>
<span id="516"> 516</span>
<span id="517"> 517</span>
<span id="518"> 518</span>
<span id="519"> 519</span>
<span id="520"> 520</span>
<span id="521"> 521</span>
<span id="522"> 522</span>
<span id="523"> 523</span>
<span id="524"> 524</span>
<span id="525"> 525</span>
<span id="526"> 526</span>
<span id="527"> 527</span>
<span id="528"> 528</span>
<span id="529"> 529</span>
<span id="530"> 530</span>
<span id="531"> 531</span>
<span id="532"> 532</span>
<span id="533"> 533</span>
<span id="534"> 534</span>
<span id="535"> 535</span>
<span id="536"> 536</span>
<span id="537"> 537</span>
<span id="538"> 538</span>
<span id="539"> 539</span>
<span id="540"> 540</span>
<span id="541"> 541</span>
<span id="542"> 542</span>
<span id="543"> 543</span>
<span id="544"> 544</span>
<span id="545"> 545</span>
<span id="546"> 546</span>
<span id="547"> 547</span>
<span id="548"> 548</span>
<span id="549"> 549</span>
<span id="550"> 550</span>
<span id="551"> 551</span>
<span id="552"> 552</span>
<span id="553"> 553</span>
<span id="554"> 554</span>
<span id="555"> 555</span>
<span id="556"> 556</span>
<span id="557"> 557</span>
<span id="558"> 558</span>
<span id="559"> 559</span>
<span id="560"> 560</span>
<span id="561"> 561</span>
<span id="562"> 562</span>
<span id="563"> 563</span>
<span id="564"> 564</span>
<span id="565"> 565</span>
<span id="566"> 566</span>
<span id="567"> 567</span>
<span id="568"> 568</span>
<span id="569"> 569</span>
<span id="570"> 570</span>
<span id="571"> 571</span>
<span id="572"> 572</span>
<span id="573"> 573</span>
<span id="574"> 574</span>
<span id="575"> 575</span>
<span id="576"> 576</span>
<span id="577"> 577</span>
<span id="578"> 578</span>
<span id="579"> 579</span>
<span id="580"> 580</span>
<span id="581"> 581</span>
<span id="582"> 582</span>
<span id="583"> 583</span>
<span id="584"> 584</span>
<span id="585"> 585</span>
<span id="586"> 586</span>
<span id="587"> 587</span>
<span id="588"> 588</span>
<span id="589"> 589</span>
<span id="590"> 590</span>
<span id="591"> 591</span>
<span id="592"> 592</span>
<span id="593"> 593</span>
<span id="594"> 594</span>
<span id="595"> 595</span>
<span id="596"> 596</span>
<span id="597"> 597</span>
<span id="598"> 598</span>
<span id="599"> 599</span>
<span id="600"> 600</span>
<span id="601"> 601</span>
<span id="602"> 602</span>
<span id="603"> 603</span>
<span id="604"> 604</span>
<span id="605"> 605</span>
<span id="606"> 606</span>
<span id="607"> 607</span>
<span id="608"> 608</span>
<span id="609"> 609</span>
<span id="610"> 610</span>
<span id="611"> 611</span>
<span id="612"> 612</span>
<span id="613"> 613</span>
<span id="614"> 614</span>
<span id="615"> 615</span>
<span id="616"> 616</span>
<span id="617"> 617</span>
<span id="618"> 618</span>
<span id="619"> 619</span>
<span id="620"> 620</span>
<span id="621"> 621</span>
<span id="622"> 622</span>
<span id="623"> 623</span>
<span id="624"> 624</span>
<span id="625"> 625</span>
<span id="626"> 626</span>
<span id="627"> 627</span>
<span id="628"> 628</span>
<span id="629"> 629</span>
<span id="630"> 630</span>
<span id="631"> 631</span>
<span id="632"> 632</span>
<span id="633"> 633</span>
<span id="634"> 634</span>
<span id="635"> 635</span>
<span id="636"> 636</span>
<span id="637"> 637</span>
<span id="638"> 638</span>
<span id="639"> 639</span>
<span id="640"> 640</span>
<span id="641"> 641</span>
<span id="642"> 642</span>
<span id="643"> 643</span>
<span id="644"> 644</span>
<span id="645"> 645</span>
<span id="646"> 646</span>
<span id="647"> 647</span>
<span id="648"> 648</span>
<span id="649"> 649</span>
<span id="650"> 650</span>
<span id="651"> 651</span>
<span id="652"> 652</span>
<span id="653"> 653</span>
<span id="654"> 654</span>
<span id="655"> 655</span>
<span id="656"> 656</span>
<span id="657"> 657</span>
<span id="658"> 658</span>
<span id="659"> 659</span>
<span id="660"> 660</span>
<span id="661"> 661</span>
<span id="662"> 662</span>
<span id="663"> 663</span>
<span id="664"> 664</span>
<span id="665"> 665</span>
<span id="666"> 666</span>
<span id="667"> 667</span>
<span id="668"> 668</span>
<span id="669"> 669</span>
<span id="670"> 670</span>
<span id="671"> 671</span>
<span id="672"> 672</span>
<span id="673"> 673</span>
<span id="674"> 674</span>
<span id="675"> 675</span>
<span id="676"> 676</span>
<span id="677"> 677</span>
<span id="678"> 678</span>
<span id="679"> 679</span>
<span id="680"> 680</span>
<span id="681"> 681</span>
<span id="682"> 682</span>
<span id="683"> 683</span>
<span id="684"> 684</span>
<span id="685"> 685</span>
<span id="686"> 686</span>
<span id="687"> 687</span>
<span id="688"> 688</span>
<span id="689"> 689</span>
<span id="690"> 690</span>
<span id="691"> 691</span>
<span id="692"> 692</span>
<span id="693"> 693</span>
<span id="694"> 694</span>
<span id="695"> 695</span>
<span id="696"> 696</span>
<span id="697"> 697</span>
<span id="698"> 698</span>
<span id="699"> 699</span>
<span id="700"> 700</span>
<span id="701"> 701</span>
<span id="702"> 702</span>
<span id="703"> 703</span>
<span id="704"> 704</span>
<span id="705"> 705</span>
<span id="706"> 706</span>
<span id="707"> 707</span>
<span id="708"> 708</span>
<span id="709"> 709</span>
<span id="710"> 710</span>
<span id="711"> 711</span>
<span id="712"> 712</span>
<span id="713"> 713</span>
<span id="714"> 714</span>
<span id="715"> 715</span>
<span id="716"> 716</span>
<span id="717"> 717</span>
<span id="718"> 718</span>
<span id="719"> 719</span>
<span id="720"> 720</span>
<span id="721"> 721</span>
<span id="722"> 722</span>
<span id="723"> 723</span>
<span id="724"> 724</span>
<span id="725"> 725</span>
<span id="726"> 726</span>
<span id="727"> 727</span>
<span id="728"> 728</span>
<span id="729"> 729</span>
<span id="730"> 730</span>
<span id="731"> 731</span>
<span id="732"> 732</span>
<span id="733"> 733</span>
<span id="734"> 734</span>
<span id="735"> 735</span>
<span id="736"> 736</span>
<span id="737"> 737</span>
<span id="738"> 738</span>
<span id="739"> 739</span>
<span id="740"> 740</span>
<span id="741"> 741</span>
<span id="742"> 742</span>
<span id="743"> 743</span>
<span id="744"> 744</span>
<span id="745"> 745</span>
<span id="746"> 746</span>
<span id="747"> 747</span>
<span id="748"> 748</span>
<span id="749"> 749</span>
<span id="750"> 750</span>
<span id="751"> 751</span>
<span id="752"> 752</span>
<span id="753"> 753</span>
<span id="754"> 754</span>
<span id="755"> 755</span>
<span id="756"> 756</span>
<span id="757"> 757</span>
<span id="758"> 758</span>
<span id="759"> 759</span>
<span id="760"> 760</span>
<span id="761"> 761</span>
<span id="762"> 762</span>
<span id="763"> 763</span>
<span id="764"> 764</span>
<span id="765"> 765</span>
<span id="766"> 766</span>
<span id="767"> 767</span>
<span id="768"> 768</span>
<span id="769"> 769</span>
<span id="770"> 770</span>
<span id="771"> 771</span>
<span id="772"> 772</span>
<span id="773"> 773</span>
<span id="774"> 774</span>
<span id="775"> 775</span>
<span id="776"> 776</span>
<span id="777"> 777</span>
<span id="778"> 778</span>
<span id="779"> 779</span>
<span id="780"> 780</span>
<span id="781"> 781</span>
<span id="782"> 782</span>
<span id="783"> 783</span>
<span id="784"> 784</span>
<span id="785"> 785</span>
<span id="786"> 786</span>
<span id="787"> 787</span>
<span id="788"> 788</span>
<span id="789"> 789</span>
<span id="790"> 790</span>
<span id="791"> 791</span>
<span id="792"> 792</span>
<span id="793"> 793</span>
<span id="794"> 794</span>
<span id="795"> 795</span>
<span id="796"> 796</span>
<span id="797"> 797</span>
<span id="798"> 798</span>
<span id="799"> 799</span>
<span id="800"> 800</span>
<span id="801"> 801</span>
<span id="802"> 802</span>
<span id="803"> 803</span>
<span id="804"> 804</span>
<span id="805"> 805</span>
<span id="806"> 806</span>
<span id="807"> 807</span>
<span id="808"> 808</span>
<span id="809"> 809</span>
<span id="810"> 810</span>
<span id="811"> 811</span>
<span id="812"> 812</span>
<span id="813"> 813</span>
<span id="814"> 814</span>
<span id="815"> 815</span>
<span id="816"> 816</span>
<span id="817"> 817</span>
<span id="818"> 818</span>
<span id="819"> 819</span>
<span id="820"> 820</span>
<span id="821"> 821</span>
<span id="822"> 822</span>
<span id="823"> 823</span>
<span id="824"> 824</span>
<span id="825"> 825</span>
<span id="826"> 826</span>
<span id="827"> 827</span>
<span id="828"> 828</span>
<span id="829"> 829</span>
<span id="830"> 830</span>
<span id="831"> 831</span>
<span id="832"> 832</span>
<span id="833"> 833</span>
<span id="834"> 834</span>
<span id="835"> 835</span>
<span id="836"> 836</span>
<span id="837"> 837</span>
<span id="838"> 838</span>
<span id="839"> 839</span>
<span id="840"> 840</span>
<span id="841"> 841</span>
<span id="842"> 842</span>
<span id="843"> 843</span>
<span id="844"> 844</span>
<span id="845"> 845</span>
<span id="846"> 846</span>
<span id="847"> 847</span>
<span id="848"> 848</span>
<span id="849"> 849</span>
<span id="850"> 850</span>
<span id="851"> 851</span>
<span id="852"> 852</span>
<span id="853"> 853</span>
<span id="854"> 854</span>
<span id="855"> 855</span>
<span id="856"> 856</span>
<span id="857"> 857</span>
<span id="858"> 858</span>
<span id="859"> 859</span>
<span id="860"> 860</span>
<span id="861"> 861</span>
<span id="862"> 862</span>
<span id="863"> 863</span>
<span id="864"> 864</span>
<span id="865"> 865</span>
<span id="866"> 866</span>
<span id="867"> 867</span>
<span id="868"> 868</span>
<span id="869"> 869</span>
<span id="870"> 870</span>
<span id="871"> 871</span>
<span id="872"> 872</span>
<span id="873"> 873</span>
<span id="874"> 874</span>
<span id="875"> 875</span>
<span id="876"> 876</span>
<span id="877"> 877</span>
<span id="878"> 878</span>
<span id="879"> 879</span>
<span id="880"> 880</span>
<span id="881"> 881</span>
<span id="882"> 882</span>
<span id="883"> 883</span>
<span id="884"> 884</span>
<span id="885"> 885</span>
<span id="886"> 886</span>
<span id="887"> 887</span>
<span id="888"> 888</span>
<span id="889"> 889</span>
<span id="890"> 890</span>
<span id="891"> 891</span>
<span id="892"> 892</span>
<span id="893"> 893</span>
<span id="894"> 894</span>
<span id="895"> 895</span>
<span id="896"> 896</span>
<span id="897"> 897</span>
<span id="898"> 898</span>
<span id="899"> 899</span>
<span id="900"> 900</span>
<span id="901"> 901</span>
<span id="902"> 902</span>
<span id="903"> 903</span>
<span id="904"> 904</span>
<span id="905"> 905</span>
<span id="906"> 906</span>
<span id="907"> 907</span>
<span id="908"> 908</span>
<span id="909"> 909</span>
<span id="910"> 910</span>
<span id="911"> 911</span>
<span id="912"> 912</span>
<span id="913"> 913</span>
<span id="914"> 914</span>
<span id="915"> 915</span>
<span id="916"> 916</span>
<span id="917"> 917</span>
<span id="918"> 918</span>
<span id="919"> 919</span>
<span id="920"> 920</span>
<span id="921"> 921</span>
<span id="922"> 922</span>
<span id="923"> 923</span>
<span id="924"> 924</span>
<span id="925"> 925</span>
<span id="926"> 926</span>
<span id="927"> 927</span>
<span id="928"> 928</span>
<span id="929"> 929</span>
<span id="930"> 930</span>
<span id="931"> 931</span>
<span id="932"> 932</span>
<span id="933"> 933</span>
<span id="934"> 934</span>
<span id="935"> 935</span>
<span id="936"> 936</span>
<span id="937"> 937</span>
<span id="938"> 938</span>
<span id="939"> 939</span>
<span id="940"> 940</span>
<span id="941"> 941</span>
<span id="942"> 942</span>
<span id="943"> 943</span>
<span id="944"> 944</span>
<span id="945"> 945</span>
<span id="946"> 946</span>
<span id="947"> 947</span>
<span id="948"> 948</span>
<span id="949"> 949</span>
<span id="950"> 950</span>
<span id="951"> 951</span>
<span id="952"> 952</span>
<span id="953"> 953</span>
<span id="954"> 954</span>
<span id="955"> 955</span>
<span id="956"> 956</span>
<span id="957"> 957</span>
<span id="958"> 958</span>
<span id="959"> 959</span>
<span id="960"> 960</span>
<span id="961"> 961</span>
<span id="962"> 962</span>
<span id="963"> 963</span>
<span id="964"> 964</span>
<span id="965"> 965</span>
<span id="966"> 966</span>
<span id="967"> 967</span>
<span id="968"> 968</span>
<span id="969"> 969</span>
<span id="970"> 970</span>
<span id="971"> 971</span>
<span id="972"> 972</span>
<span id="973"> 973</span>
<span id="974"> 974</span>
<span id="975"> 975</span>
<span id="976"> 976</span>
<span id="977"> 977</span>
<span id="978"> 978</span>
<span id="979"> 979</span>
<span id="980"> 980</span>
<span id="981"> 981</span>
<span id="982"> 982</span>
<span id="983"> 983</span>
<span id="984"> 984</span>
<span id="985"> 985</span>
<span id="986"> 986</span>
<span id="987"> 987</span>
<span id="988"> 988</span>
<span id="989"> 989</span>
<span id="990"> 990</span>
<span id="991"> 991</span>
<span id="992"> 992</span>
<span id="993"> 993</span>
<span id="994"> 994</span>
<span id="995"> 995</span>
<span id="996"> 996</span>
<span id="997"> 997</span>
<span id="998"> 998</span>
<span id="999"> 999</span>
<span id="1000">1000</span>
<span id="1001">1001</span>
<span id="1002">1002</span>
<span id="1003">1003</span>
<span id="1004">1004</span>
<span id="1005">1005</span>
<span id="1006">1006</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2012 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="kw">use</span> <span class="ident">ascii</span>;
<span class="kw">use</span> <span class="ident">borrow</span>::{<span class="ident">Cow</span>, <span class="ident">Borrow</span>};
<span class="kw">use</span> <span class="ident">cmp</span>::<span class="ident">Ordering</span>;
<span class="kw">use</span> <span class="ident">error</span>::<span class="ident">Error</span>;
<span class="kw">use</span> <span class="ident">fmt</span>::{<span class="self">self</span>, <span class="ident">Write</span>};
<span class="kw">use</span> <span class="ident">io</span>;
<span class="kw">use</span> <span class="ident">libc</span>;
<span class="kw">use</span> <span class="ident">mem</span>;
<span class="kw">use</span> <span class="ident">memchr</span>;
<span class="kw">use</span> <span class="ident">ops</span>;
<span class="kw">use</span> <span class="ident">os</span>::<span class="ident">raw</span>::<span class="ident">c_char</span>;
<span class="kw">use</span> <span class="ident">ptr</span>;
<span class="kw">use</span> <span class="ident">slice</span>;
<span class="kw">use</span> <span class="ident">str</span>::{<span class="self">self</span>, <span class="ident">Utf8Error</span>};
<span class="doccomment">/// A type representing an owned C-compatible string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This type serves the primary purpose of being able to safely generate a</span>
<span class="doccomment">/// C-compatible string from a Rust byte slice or vector. An instance of this</span>
<span class="doccomment">/// type is a static guarantee that the underlying bytes contain no interior 0</span>
<span class="doccomment">/// bytes and the final byte is 0.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A `CString` is created from either a byte slice or a byte vector. A [`u8`]</span>
<span class="doccomment">/// slice can be obtained with the `as_bytes` method. Slices produced from a</span>
<span class="doccomment">/// `CString` do *not* contain the trailing nul terminator unless otherwise</span>
<span class="doccomment">/// specified.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`u8`]: ../primitive.u8.html</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// use std::ffi::CString;</span>
<span class="doccomment">/// use std::os::raw::c_char;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// extern {</span>
<span class="doccomment">/// fn my_printer(s: *const c_char);</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let c_to_print = CString::new("Hello, world!").unwrap();</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// my_printer(c_to_print.as_ptr());</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// `CString` is intended for working with traditional C-style strings</span>
<span class="doccomment">/// (a sequence of non-null bytes terminated by a single null byte); the</span>
<span class="doccomment">/// primary use case for these kinds of strings is interoperating with C-like</span>
<span class="doccomment">/// code. Often you will need to transfer ownership to/from that external</span>
<span class="doccomment">/// code. It is strongly recommended that you thoroughly read through the</span>
<span class="doccomment">/// documentation of `CString` before use, as improper ownership management</span>
<span class="doccomment">/// of `CString` instances can lead to invalid memory accesses, memory leaks,</span>
<span class="doccomment">/// and other memory errors.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">PartialEq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Eq</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>, <span class="ident">Clone</span>)]</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">CString</span> {
<span class="comment">// Invariant 1: the slice ends with a zero byte and has a length of at least one.</span>
<span class="comment">// Invariant 2: the slice contains only one zero byte.</span>
<span class="comment">// Improper usage of unsafe function can break Invariant 2, but not Invariant 1.</span>
<span class="ident">inner</span>: <span class="ident">Box</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span>,
}
<span class="doccomment">/// Representation of a borrowed C string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This dynamically sized type is only safely constructed via a borrowed</span>
<span class="doccomment">/// version of an instance of `CString`. This type can be constructed from a raw</span>
<span class="doccomment">/// C string as well and represents a C string borrowed from another location.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this structure is **not** `repr(C)` and is not recommended to be</span>
<span class="doccomment">/// placed in the signatures of FFI functions. Instead safe wrappers of FFI</span>
<span class="doccomment">/// functions may leverage the unsafe [`from_ptr`] constructor to provide a safe</span>
<span class="doccomment">/// interface to other consumers.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`from_ptr`]: #method.from_ptr</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Inspecting a foreign C string:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// use std::ffi::CStr;</span>
<span class="doccomment">/// use std::os::raw::c_char;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// extern { fn my_string() -> *const c_char; }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// let slice = CStr::from_ptr(my_string());</span>
<span class="doccomment">/// println!("string length: {}", slice.to_bytes().len());</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Passing a Rust-originating C string:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// use std::ffi::{CString, CStr};</span>
<span class="doccomment">/// use std::os::raw::c_char;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn work(data: &CStr) {</span>
<span class="doccomment">/// extern { fn work_with(data: *const c_char); }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// unsafe { work_with(data.as_ptr()) }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let s = CString::new("data data data data").unwrap();</span>
<span class="doccomment">/// work(&s);</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Converting a foreign C string into a Rust [`String`]:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`String`]: ../string/struct.String.html</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// use std::ffi::CStr;</span>
<span class="doccomment">/// use std::os::raw::c_char;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// extern { fn my_string() -> *const c_char; }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn my_string_safe() -> String {</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// CStr::from_ptr(my_string()).to_string_lossy().into_owned()</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// println!("string: {}", my_string_safe());</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Hash</span>)]</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">CStr</span> {
<span class="comment">// FIXME: this should not be represented with a DST slice but rather with</span>
<span class="comment">// just a raw `c_char` along with some form of marker to make</span>
<span class="comment">// this an unsized type. Essentially `sizeof(&CStr)` should be the</span>
<span class="comment">// same as `sizeof(&c_char)` but `CStr` should be an unsized type.</span>
<span class="ident">inner</span>: [<span class="ident">c_char</span>]
}
<span class="doccomment">/// An error returned from [`CString::new`] to indicate that a nul byte was found</span>
<span class="doccomment">/// in the vector provided.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CString::new`]: struct.CString.html#method.new</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">NulError</span>(<span class="ident">usize</span>, <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>);
<span class="doccomment">/// An error returned from [`CStr::from_bytes_with_nul`] to indicate that a nul</span>
<span class="doccomment">/// byte was found too early in the slice provided or one wasn't found at all.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CStr::from_bytes_with_nul`]: struct.CStr.html#method.from_bytes_with_nul</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_from_bytes"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.10.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">FromBytesWithNulError</span> {
<span class="ident">kind</span>: <span class="ident">FromBytesWithNulErrorKind</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Debug</span>)]</span>
<span class="kw">enum</span> <span class="ident">FromBytesWithNulErrorKind</span> {
<span class="ident">InteriorNul</span>(<span class="ident">usize</span>),
<span class="ident">NotNulTerminated</span>,
}
<span class="kw">impl</span> <span class="ident">FromBytesWithNulError</span> {
<span class="kw">fn</span> <span class="ident">interior_nul</span>(<span class="ident">pos</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">FromBytesWithNulError</span> {
<span class="ident">FromBytesWithNulError</span> {
<span class="ident">kind</span>: <span class="ident">FromBytesWithNulErrorKind</span>::<span class="ident">InteriorNul</span>(<span class="ident">pos</span>),
}
}
<span class="kw">fn</span> <span class="ident">not_nul_terminated</span>() <span class="op">-></span> <span class="ident">FromBytesWithNulError</span> {
<span class="ident">FromBytesWithNulError</span> {
<span class="ident">kind</span>: <span class="ident">FromBytesWithNulErrorKind</span>::<span class="ident">NotNulTerminated</span>,
}
}
}
<span class="doccomment">/// An error returned from [`CString::into_string`] to indicate that a UTF-8 error</span>
<span class="doccomment">/// was encountered during the conversion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CString::into_string`]: struct.CString.html#method.into_string</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Debug</span>)]</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">IntoStringError</span> {
<span class="ident">inner</span>: <span class="ident">CString</span>,
<span class="ident">error</span>: <span class="ident">Utf8Error</span>,
}
<span class="kw">impl</span> <span class="ident">CString</span> {
<span class="doccomment">/// Creates a new C-compatible string from a container of bytes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method will consume the provided data and use the underlying bytes</span>
<span class="doccomment">/// to construct a new string, ensuring that there is a trailing 0 byte.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// use std::ffi::CString;</span>
<span class="doccomment">/// use std::os::raw::c_char;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// extern { fn puts(s: *const c_char); }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let to_print = CString::new("Hello!").unwrap();</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// puts(to_print.as_ptr());</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Errors</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will return an error if the bytes yielded contain an</span>
<span class="doccomment">/// internal 0 byte. The error returned will contain the bytes as well as</span>
<span class="doccomment">/// the position of the nul byte.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">>></span><span class="op">></span>(<span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">CString</span>, <span class="ident">NulError</span><span class="op">></span> {
<span class="self">Self</span>::<span class="ident">_new</span>(<span class="ident">t</span>.<span class="ident">into</span>())
}
<span class="kw">fn</span> <span class="ident">_new</span>(<span class="ident">bytes</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">CString</span>, <span class="ident">NulError</span><span class="op">></span> {
<span class="kw">match</span> <span class="ident">memchr</span>::<span class="ident">memchr</span>(<span class="number">0</span>, <span class="kw-2">&</span><span class="ident">bytes</span>) {
<span class="prelude-val">Some</span>(<span class="ident">i</span>) <span class="op">=></span> <span class="prelude-val">Err</span>(<span class="ident">NulError</span>(<span class="ident">i</span>, <span class="ident">bytes</span>)),
<span class="prelude-val">None</span> <span class="op">=></span> <span class="prelude-val">Ok</span>(<span class="kw">unsafe</span> { <span class="ident">CString</span>::<span class="ident">from_vec_unchecked</span>(<span class="ident">bytes</span>) }),
}
}
<span class="doccomment">/// Creates a C-compatible string from a byte vector without checking for</span>
<span class="doccomment">/// interior 0 bytes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is equivalent to [`new`] except that no runtime assertion</span>
<span class="doccomment">/// is made that `v` contains no 0 bytes, and it requires an actual</span>
<span class="doccomment">/// byte vector, not anything that can be converted to one with Into.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`new`]: #method.new</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::CString;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let raw = b"foo".to_vec();</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// let c_string = CString::from_vec_unchecked(raw);</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_vec_unchecked</span>(<span class="kw-2">mut</span> <span class="ident">v</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="ident">v</span>.<span class="ident">reserve_exact</span>(<span class="number">1</span>);
<span class="ident">v</span>.<span class="ident">push</span>(<span class="number">0</span>);
<span class="ident">CString</span> { <span class="ident">inner</span>: <span class="ident">v</span>.<span class="ident">into_boxed_slice</span>() }
}
<span class="doccomment">/// Retakes ownership of a `CString` that was transferred to C.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Additionally, the length of the string will be recalculated from the pointer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This should only ever be called with a pointer that was earlier</span>
<span class="doccomment">/// obtained by calling [`into_raw`] on a `CString`. Other usage (e.g. trying to take</span>
<span class="doccomment">/// ownership of a string that was allocated by foreign code) is likely to lead</span>
<span class="doccomment">/// to undefined behavior or allocator corruption.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`into_raw`]: #method.into_raw</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_memory"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.4.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_raw</span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_char</span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">strlen</span>(<span class="ident">ptr</span>) <span class="op">+</span> <span class="number">1</span>; <span class="comment">// Including the NUL byte</span>
<span class="kw">let</span> <span class="ident">slice</span> <span class="op">=</span> <span class="ident">slice</span>::<span class="ident">from_raw_parts</span>(<span class="ident">ptr</span>, <span class="ident">len</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="ident">CString</span> { <span class="ident">inner</span>: <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">slice</span>) }
}
<span class="doccomment">/// Transfers ownership of the string to a C caller.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The pointer must be returned to Rust and reconstituted using</span>
<span class="doccomment">/// [`from_raw`] to be properly deallocated. Specifically, one</span>
<span class="doccomment">/// should *not* use the standard C `free` function to deallocate</span>
<span class="doccomment">/// this string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Failure to call [`from_raw`] will lead to a memory leak.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`from_raw`]: #method.from_raw</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_memory"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.4.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_raw</span>(<span class="self">self</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_char</span> {
<span class="ident">Box</span>::<span class="ident">into_raw</span>(<span class="self">self</span>.<span class="ident">into_inner</span>()) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_char</span>
}
<span class="doccomment">/// Converts the `CString` into a [`String`] if it contains valid Unicode data.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On failure, ownership of the original `CString` is returned.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`String`]: ../string/struct.String.html</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_string</span>(<span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">IntoStringError</span><span class="op">></span> {
<span class="ident">String</span>::<span class="ident">from_utf8</span>(<span class="self">self</span>.<span class="ident">into_bytes</span>())
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">e</span><span class="op">|</span> <span class="ident">IntoStringError</span> {
<span class="ident">error</span>: <span class="ident">e</span>.<span class="ident">utf8_error</span>(),
<span class="ident">inner</span>: <span class="kw">unsafe</span> { <span class="ident">CString</span>::<span class="ident">from_vec_unchecked</span>(<span class="ident">e</span>.<span class="ident">into_bytes</span>()) },
})
}
<span class="doccomment">/// Returns the underlying byte buffer.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned buffer does **not** contain the trailing nul separator and</span>
<span class="doccomment">/// it is guaranteed to not have any interior nul bytes.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_bytes</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">vec</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">into_inner</span>().<span class="ident">into_vec</span>();
<span class="kw">let</span> <span class="ident">_nul</span> <span class="op">=</span> <span class="ident">vec</span>.<span class="ident">pop</span>();
<span class="macro">debug_assert_eq</span><span class="macro">!</span>(<span class="ident">_nul</span>, <span class="prelude-val">Some</span>(<span class="number">0u8</span>));
<span class="ident">vec</span>
}
<span class="doccomment">/// Equivalent to the [`into_bytes`] function except that the returned vector</span>
<span class="doccomment">/// includes the trailing nul byte.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`into_bytes`]: #method.into_bytes</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_bytes_with_nul</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">into_inner</span>().<span class="ident">into_vec</span>()
}
<span class="doccomment">/// Returns the contents of this `CString` as a slice of bytes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned slice does **not** contain the trailing nul separator and</span>
<span class="doccomment">/// it is guaranteed to not have any interior nul bytes.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_bytes</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>[..<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="number">1</span>]
}
<span class="doccomment">/// Equivalent to the [`as_bytes`] function except that the returned slice</span>
<span class="doccomment">/// includes the trailing nul byte.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`as_bytes`]: #method.as_bytes</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_bytes_with_nul</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>
}
<span class="doccomment">/// Extracts a [`CStr`] slice containing the entire string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CStr`]: struct.CStr.html</span>
<span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"as_c_str"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"40380"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_c_str</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> {
<span class="kw-2">&</span><span class="kw-2">*</span><span class="self">self</span>
}
<span class="doccomment">/// Converts this `CString` into a boxed [`CStr`].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CStr`]: struct.CStr.html</span>
<span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"into_boxed_c_str"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"40380"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_boxed_c_str</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> {
<span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="self">self</span>.<span class="ident">into_inner</span>()) }
}
<span class="comment">// Bypass "move out of struct which implements [`Drop`] trait" restriction.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Drop`]: ../ops/trait.Drop.html</span>
<span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Box</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> {
<span class="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">ptr</span>::<span class="ident">read</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>);
<span class="ident">mem</span>::<span class="ident">forget</span>(<span class="self">self</span>);
<span class="ident">result</span>
}
}
}
<span class="comment">// Turns this `CString` into an empty string to prevent</span>
<span class="comment">// memory unsafe code from working by accident. Inline</span>
<span class="comment">// to prevent LLVM from optimizing it away in debug builds.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_drop"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.13.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw">unsafe</span> { <span class="kw-2">*</span><span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_unchecked_mut</span>(<span class="number">0</span>) <span class="op">=</span> <span class="number">0</span>; }
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">ops</span>::<span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">CStr</span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> {
<span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul_unchecked</span>(<span class="self">self</span>.<span class="ident">as_bytes_with_nul</span>()) }
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">fmt</span>::<span class="ident">Debug</span>::<span class="ident">fmt</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="kw-2">*</span><span class="self">self</span>, <span class="ident">f</span>)
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">CString</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">s</span>: <span class="ident">CString</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> {
<span class="ident">s</span>.<span class="ident">into_bytes</span>()
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_debug"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.3.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">CStr</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"\""</span>)<span class="question-mark">?</span>;
<span class="kw">for</span> <span class="ident">byte</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">to_bytes</span>().<span class="ident">iter</span>().<span class="ident">flat_map</span>(<span class="op">|</span><span class="kw-2">&</span><span class="ident">b</span><span class="op">|</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="ident">b</span>)) {
<span class="ident">f</span>.<span class="ident">write_char</span>(<span class="ident">byte</span> <span class="kw">as</span> <span class="ident">char</span>)<span class="question-mark">?</span>;
}
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"\""</span>)
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_default"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.10.0"</span>)]</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Default</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span> {
<span class="kw">static</span> <span class="ident">SLICE</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">c_char</span>] <span class="op">=</span> <span class="kw-2">&</span>[<span class="number">0</span>];
<span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">SLICE</span>.<span class="ident">as_ptr</span>()) }
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_default"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.10.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="doccomment">/// Creates an empty `CString`.</span>
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="ident">CString</span> {
<span class="kw">let</span> <span class="ident">a</span>: <span class="kw-2">&</span><span class="ident">CStr</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
<span class="ident">a</span>.<span class="ident">to_owned</span>()
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_borrow"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.3.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Borrow</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">fn</span> <span class="ident">borrow</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> { <span class="self">self</span> }
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"box_from_c_str"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.17.0"</span>)]</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">boxed</span>: <span class="ident">Box</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">from</span>(<span class="ident">s</span>.<span class="ident">to_bytes_with_nul</span>());
<span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">boxed</span>) }
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"c_string_from_box"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.18.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">>></span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">s</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="ident">s</span>.<span class="ident">into_c_string</span>()
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"box_from_c_string"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.18.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Into</span><span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">>></span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">fn</span> <span class="ident">into</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">into_boxed_c_str</span>()
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"default_box_extra"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.17.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">boxed</span>: <span class="ident">Box</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">from</span>([<span class="number">0</span>]);
<span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">boxed</span>) }
}
}
<span class="kw">impl</span> <span class="ident">NulError</span> {
<span class="doccomment">/// Returns the position of the nul byte in the slice that was provided to</span>
<span class="doccomment">/// [`CString::new`].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CString::new`]: struct.CString.html#method.new</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::CString;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let nul_error = CString::new("foo\0bar").unwrap_err();</span>
<span class="doccomment">/// assert_eq!(nul_error.nul_position(), 3);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let nul_error = CString::new("foo bar\0").unwrap_err();</span>
<span class="doccomment">/// assert_eq!(nul_error.nul_position(), 7);</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">nul_position</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { <span class="self">self</span>.<span class="number">0</span> }
<span class="doccomment">/// Consumes this error, returning the underlying vector of bytes which</span>
<span class="doccomment">/// generated the error in the first place.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::CString;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let nul_error = CString::new("foo\0bar").unwrap_err();</span>
<span class="doccomment">/// assert_eq!(nul_error.into_vec(), b"foo\0bar");</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_vec</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> { <span class="self">self</span>.<span class="number">1</span> }
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">NulError</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> { <span class="string">"nul byte found in data"</span> }
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">NulError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"nul byte found in provided data at position: {}"</span>, <span class="self">self</span>.<span class="number">0</span>)
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">NulError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">io</span>::<span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">from</span>(_: <span class="ident">NulError</span>) <span class="op">-></span> <span class="ident">io</span>::<span class="ident">Error</span> {
<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">ErrorKind</span>::<span class="ident">InvalidInput</span>,
<span class="string">"data provided contains a nul byte"</span>)
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"frombyteswithnulerror_impls"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.17.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">FromBytesWithNulError</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">kind</span> {
<span class="ident">FromBytesWithNulErrorKind</span>::<span class="ident">InteriorNul</span>(..) <span class="op">=></span>
<span class="string">"data provided contains an interior nul byte"</span>,
<span class="ident">FromBytesWithNulErrorKind</span>::<span class="ident">NotNulTerminated</span> <span class="op">=></span>
<span class="string">"data provided is not nul terminated"</span>,
}
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"frombyteswithnulerror_impls"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.17.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">FromBytesWithNulError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="ident">f</span>.<span class="ident">write_str</span>(<span class="self">self</span>.<span class="ident">description</span>())<span class="question-mark">?</span>;
<span class="kw">if</span> <span class="kw">let</span> <span class="ident">FromBytesWithNulErrorKind</span>::<span class="ident">InteriorNul</span>(<span class="ident">pos</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">kind</span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">" at byte pos {}"</span>, <span class="ident">pos</span>)<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl</span> <span class="ident">IntoStringError</span> {
<span class="doccomment">/// Consumes this error, returning original [`CString`] which generated the</span>
<span class="doccomment">/// error.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`CString`]: struct.CString.html</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_cstring</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="self">self</span>.<span class="ident">inner</span>
}
<span class="doccomment">/// Access the underlying UTF-8 error that was the cause of this error.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">utf8_error</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Utf8Error</span> {
<span class="self">self</span>.<span class="ident">error</span>
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">IntoStringError</span> {
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="string">"C string contained non-utf8 bytes"</span>
}
<span class="kw">fn</span> <span class="ident">cause</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">Error</span><span class="op">></span> {
<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">error</span>)
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_into"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">IntoStringError</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> {
<span class="self">self</span>.<span class="ident">description</span>().<span class="ident">fmt</span>(<span class="ident">f</span>)
}
}
<span class="kw">impl</span> <span class="ident">CStr</span> {
<span class="doccomment">/// Casts a raw C string to a safe C string wrapper.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will cast the provided `ptr` to the `CStr` wrapper which</span>
<span class="doccomment">/// allows inspection and interoperation of non-owned C strings. This method</span>
<span class="doccomment">/// is unsafe for a number of reasons:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * There is no guarantee to the validity of `ptr`.</span>
<span class="doccomment">/// * The returned lifetime is not guaranteed to be the actual lifetime of</span>
<span class="doccomment">/// `ptr`.</span>
<span class="doccomment">/// * There is no guarantee that the memory pointed to by `ptr` contains a</span>
<span class="doccomment">/// valid nul terminator byte at the end of the string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This operation is intended to be a 0-cost cast but it is</span>
<span class="doccomment">/// > currently implemented with an up-front calculation of the length of</span>
<span class="doccomment">/// > the string. This is not guaranteed to always be the case.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// use std::ffi::CStr;</span>
<span class="doccomment">/// use std::os::raw::c_char;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// extern {</span>
<span class="doccomment">/// fn my_string() -> *const c_char;</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// let slice = CStr::from_ptr(my_string());</span>
<span class="doccomment">/// println!("string returned: {}", slice.to_str().unwrap());</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_ptr</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span> {
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">strlen</span>(<span class="ident">ptr</span>);
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">u8</span>;
<span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul_unchecked</span>(<span class="ident">slice</span>::<span class="ident">from_raw_parts</span>(<span class="ident">ptr</span>, <span class="ident">len</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">+</span> <span class="number">1</span>))
}
<span class="doccomment">/// Creates a C string wrapper from a byte slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will cast the provided `bytes` to a `CStr` wrapper after</span>
<span class="doccomment">/// ensuring that it is null terminated and does not contain any interior</span>
<span class="doccomment">/// nul bytes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::CStr;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let cstr = CStr::from_bytes_with_nul(b"hello\0");</span>
<span class="doccomment">/// assert!(cstr.is_ok());</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_from_bytes"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.10.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_bytes_with_nul</span>(<span class="ident">bytes</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>])
<span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">CStr</span>, <span class="ident">FromBytesWithNulError</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">nul_pos</span> <span class="op">=</span> <span class="ident">memchr</span>::<span class="ident">memchr</span>(<span class="number">0</span>, <span class="ident">bytes</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">nul_pos</span>) <span class="op">=</span> <span class="ident">nul_pos</span> {
<span class="kw">if</span> <span class="ident">nul_pos</span> <span class="op">+</span> <span class="number">1</span> <span class="op">!=</span> <span class="ident">bytes</span>.<span class="ident">len</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">FromBytesWithNulError</span>::<span class="ident">interior_nul</span>(<span class="ident">nul_pos</span>));
}
<span class="prelude-val">Ok</span>(<span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul_unchecked</span>(<span class="ident">bytes</span>) })
} <span class="kw">else</span> {
<span class="prelude-val">Err</span>(<span class="ident">FromBytesWithNulError</span>::<span class="ident">not_nul_terminated</span>())
}
}
<span class="doccomment">/// Unsafely creates a C string wrapper from a byte slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will cast the provided `bytes` to a `CStr` wrapper without</span>
<span class="doccomment">/// performing any sanity checks. The provided slice must be null terminated</span>
<span class="doccomment">/// and not contain any interior nul bytes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use std::ffi::{CStr, CString};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// let cstring = CString::new("hello").unwrap();</span>
<span class="doccomment">/// let cstr = CStr::from_bytes_with_nul_unchecked(cstring.to_bytes_with_nul());</span>
<span class="doccomment">/// assert_eq!(cstr, &*cstring);</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_from_bytes"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.10.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_bytes_with_nul_unchecked</span>(<span class="ident">bytes</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> {
<span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">bytes</span>)
}
<span class="doccomment">/// Returns the inner pointer to this C string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned pointer will be valid for as long as `self` is and points</span>
<span class="doccomment">/// to a contiguous region of memory terminated with a 0 byte to represent</span>
<span class="doccomment">/// the end of the string.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **WARNING**</span>
<span class="doccomment">///</span>
<span class="doccomment">/// It is your responsibility to make sure that the underlying memory is not</span>
<span class="doccomment">/// freed too early. For example, the following code will cause undefined</span>
<span class="doccomment">/// behaviour when `ptr` is used inside the `unsafe` block:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// use std::ffi::{CString};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let ptr = CString::new("Hello").unwrap().as_ptr();</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// // `ptr` is dangling</span>
<span class="doccomment">/// *ptr;</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This happens because the pointer returned by `as_ptr` does not carry any</span>
<span class="doccomment">/// lifetime information and the string is deallocated immediately after</span>
<span class="doccomment">/// the `CString::new("Hello").unwrap().as_ptr()` expression is evaluated.</span>
<span class="doccomment">/// To fix the problem, bind the string to a local variable:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```no_run</span>
<span class="doccomment">/// use std::ffi::{CString};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let hello = CString::new("Hello").unwrap();</span>
<span class="doccomment">/// let ptr = hello.as_ptr();</span>
<span class="doccomment">/// unsafe {</span>
<span class="doccomment">/// // `ptr` is valid because `hello` is in scope</span>
<span class="doccomment">/// *ptr;</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_ptr</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">as_ptr</span>()
}
<span class="doccomment">/// Converts this C string to a byte slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will calculate the length of this string (which normally</span>
<span class="doccomment">/// requires a linear amount of work to be done) and then return the</span>
<span class="doccomment">/// resulting slice of `u8` elements.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The returned slice will **not** contain the trailing nul that this C</span>
<span class="doccomment">/// string has.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This method is currently implemented as a 0-cost cast, but</span>
<span class="doccomment">/// > it is planned to alter its definition in the future to perform the</span>
<span class="doccomment">/// > length calculation whenever this method is called.</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_bytes</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] {
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">to_bytes_with_nul</span>();
<span class="kw-2">&</span><span class="ident">bytes</span>[..<span class="ident">bytes</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="number">1</span>]
}
<span class="doccomment">/// Converts this C string to a byte slice containing the trailing 0 byte.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function is the equivalent of [`to_bytes`] except that it will retain</span>
<span class="doccomment">/// the trailing nul instead of chopping it off.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This method is currently implemented as a 0-cost cast, but</span>
<span class="doccomment">/// > it is planned to alter its definition in the future to perform the</span>
<span class="doccomment">/// > length calculation whenever this method is called.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`to_bytes`]: #method.to_bytes</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_bytes_with_nul</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] {
<span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inner</span>) }
}
<span class="doccomment">/// Yields a [`&str`] slice if the `CStr` contains valid UTF-8.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will calculate the length of this string and check for</span>
<span class="doccomment">/// UTF-8 validity, and then return the [`&str`] if it's valid.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This method is currently implemented to check for validity</span>
<span class="doccomment">/// > after a 0-cost cast, but it is planned to alter its definition in the</span>
<span class="doccomment">/// > future to perform the length calculation in addition to the UTF-8</span>
<span class="doccomment">/// > check whenever this method is called.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`&str`]: ../primitive.str.html</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_to_str"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.4.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_str</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">str</span>::<span class="ident">Utf8Error</span><span class="op">></span> {
<span class="comment">// NB: When CStr is changed to perform the length check in .to_bytes()</span>
<span class="comment">// instead of in from_ptr(), it may be worth considering if this should</span>
<span class="comment">// be rewritten to do the UTF-8 check inline with the length calculation</span>
<span class="comment">// instead of doing it afterwards.</span>
<span class="ident">str</span>::<span class="ident">from_utf8</span>(<span class="self">self</span>.<span class="ident">to_bytes</span>())
}
<span class="doccomment">/// Converts a `CStr` into a [`Cow`]`<`[`str`]`>`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function will calculate the length of this string (which normally</span>
<span class="doccomment">/// requires a linear amount of work to be done) and then return the</span>
<span class="doccomment">/// resulting slice as a [`Cow`]`<`[`str`]`>`, replacing any invalid UTF-8 sequences</span>
<span class="doccomment">/// with `U+FFFD REPLACEMENT CHARACTER`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This method is currently implemented to check for validity</span>
<span class="doccomment">/// > after a 0-cost cast, but it is planned to alter its definition in the</span>
<span class="doccomment">/// > future to perform the length calculation in addition to the UTF-8</span>
<span class="doccomment">/// > check whenever this method is called.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Cow`]: ../borrow/enum.Cow.html</span>
<span class="doccomment">/// [`str`]: ../primitive.str.html</span>
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_to_str"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.4.0"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_string_lossy</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Cow</span><span class="op"><</span><span class="ident">str</span><span class="op">></span> {
<span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="self">self</span>.<span class="ident">to_bytes</span>())
}
<span class="doccomment">/// Converts a [`Box`]`<CStr>` into a [`CString`] without copying or allocating.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`Box`]: ../boxed/struct.Box.html</span>
<span class="doccomment">/// [`CString`]: struct.CString.html</span>
<span class="attribute">#[<span class="ident">unstable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"into_boxed_c_str"</span>, <span class="ident">issue</span> <span class="op">=</span> <span class="string">"40380"</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_c_string</span>(<span class="self">self</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="self">self</span>) }
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">PartialEq</span> <span class="kw">for</span> <span class="ident">CStr</span> {
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">to_bytes</span>().<span class="ident">eq</span>(<span class="ident">other</span>.<span class="ident">to_bytes</span>())
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Eq</span> <span class="kw">for</span> <span class="ident">CStr</span> {}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">PartialOrd</span> <span class="kw">for</span> <span class="ident">CStr</span> {
<span class="kw">fn</span> <span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Ordering</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">to_bytes</span>().<span class="ident">partial_cmp</span>(<span class="kw-2">&</span><span class="ident">other</span>.<span class="ident">to_bytes</span>())
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rust1"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.0.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">Ord</span> <span class="kw">for</span> <span class="ident">CStr</span> {
<span class="kw">fn</span> <span class="ident">cmp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">Ordering</span> {
<span class="self">self</span>.<span class="ident">to_bytes</span>().<span class="ident">cmp</span>(<span class="kw-2">&</span><span class="ident">other</span>.<span class="ident">to_bytes</span>())
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstr_borrow"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.3.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">ToOwned</span> <span class="kw">for</span> <span class="ident">CStr</span> {
<span class="kw">type</span> <span class="ident">Owned</span> <span class="op">=</span> <span class="ident">CString</span>;
<span class="kw">fn</span> <span class="ident">to_owned</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="ident">CString</span> { <span class="ident">inner</span>: <span class="self">self</span>.<span class="ident">to_bytes_with_nul</span>().<span class="ident">into</span>() }
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_asref"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CStr</span>) <span class="op">-></span> <span class="ident">CString</span> {
<span class="ident">s</span>.<span class="ident">to_owned</span>()
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_asref"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">ops</span>::<span class="ident">Index</span><span class="op"><</span><span class="ident">ops</span>::<span class="ident">RangeFull</span><span class="op">></span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="ident">CStr</span>;
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">index</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">_index</span>: <span class="ident">ops</span>::<span class="ident">RangeFull</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> {
<span class="self">self</span>
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_asref"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">CStr</span> {
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> {
<span class="self">self</span>
}
}
<span class="attribute">#[<span class="ident">stable</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"cstring_asref"</span>, <span class="ident">since</span> <span class="op">=</span> <span class="string">"1.7.0"</span>)]</span>
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> <span class="kw">for</span> <span class="ident">CString</span> {
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">CStr</span> {
<span class="self">self</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">os</span>::<span class="ident">raw</span>::<span class="ident">c_char</span>;
<span class="kw">use</span> <span class="ident">borrow</span>::<span class="ident">Cow</span>::{<span class="ident">Borrowed</span>, <span class="ident">Owned</span>};
<span class="kw">use</span> <span class="ident">hash</span>::{<span class="ident">Hash</span>, <span class="ident">Hasher</span>};
<span class="kw">use</span> <span class="ident">collections</span>::<span class="ident">hash_map</span>::<span class="ident">DefaultHasher</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">c_to_rust</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123\0"</span>;
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">data</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>;
<span class="kw">unsafe</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_bytes</span>(), <span class="string">b"123"</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_bytes_with_nul</span>(), <span class="string">b"123\0"</span>);
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">simple</span>() {
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">CString</span>::<span class="ident">new</span>(<span class="string">"1234"</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">as_bytes</span>(), <span class="string">b"1234"</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">as_bytes_with_nul</span>(), <span class="string">b"1234\0"</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">build_with_zero1</span>() {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="string">b"\0"</span>[..]).<span class="ident">is_err</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">build_with_zero2</span>() {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">CString</span>::<span class="ident">new</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>]).<span class="ident">is_err</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">build_with_zero3</span>() {
<span class="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">CString</span>::<span class="ident">from_vec_unchecked</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="number">0</span>]);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">as_bytes</span>(), <span class="string">b"\0"</span>);
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">formatted</span>() {
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">CString</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="string">b"abc\x01\x02\n\xE2\x80\xA6\xFF"</span>[..]).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">s</span>), <span class="string">r#""abc\x01\x02\n\xe2\x80\xa6\xff""#</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">borrowed</span>() {
<span class="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="string">b"12\0"</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> _);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">to_bytes</span>(), <span class="string">b"12"</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">to_bytes_with_nul</span>(), <span class="string">b"12\0"</span>);
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">to_str</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123\xE2\x80\xA6\0"</span>;
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">data</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>;
<span class="kw">unsafe</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_str</span>(), <span class="prelude-val">Ok</span>(<span class="string">"123…"</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_string_lossy</span>(), <span class="ident">Borrowed</span>(<span class="string">"123…"</span>));
}
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123\xE2\0"</span>;
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">data</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>;
<span class="kw">unsafe</span> {
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_str</span>().<span class="ident">is_err</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_string_lossy</span>(), <span class="ident">Owned</span>::<span class="op"><</span><span class="ident">str</span><span class="op">></span>(<span class="macro">format</span><span class="macro">!</span>(<span class="string">"123\u{FFFD}"</span>)));
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">to_owned</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123\0"</span>;
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">data</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>;
<span class="kw">let</span> <span class="ident">owned</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>).<span class="ident">to_owned</span>() };
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">owned</span>.<span class="ident">as_bytes_with_nul</span>(), <span class="ident">data</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">equal_hash</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123\xE2\xFA\xA6\0"</span>;
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">data</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>;
<span class="kw">let</span> <span class="ident">cstr</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">CStr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">CStr</span>::<span class="ident">from_ptr</span>(<span class="ident">ptr</span>) };
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">DefaultHasher</span>::<span class="ident">new</span>();
<span class="ident">cstr</span>.<span class="ident">hash</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">s</span>);
<span class="kw">let</span> <span class="ident">cstr_hash</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">finish</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">s</span> <span class="op">=</span> <span class="ident">DefaultHasher</span>::<span class="ident">new</span>();
<span class="ident">CString</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">data</span>[..<span class="ident">data</span>.<span class="ident">len</span>() <span class="op">-</span> <span class="number">1</span>]).<span class="ident">unwrap</span>().<span class="ident">hash</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">s</span>);
<span class="kw">let</span> <span class="ident">cstring_hash</span> <span class="op">=</span> <span class="ident">s</span>.<span class="ident">finish</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cstr_hash</span>, <span class="ident">cstring_hash</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">from_bytes_with_nul</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123\0"</span>;
<span class="kw">let</span> <span class="ident">cstr</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul</span>(<span class="ident">data</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cstr</span>.<span class="ident">map</span>(<span class="ident">CStr</span>::<span class="ident">to_bytes</span>), <span class="prelude-val">Ok</span>(<span class="kw-2">&</span><span class="string">b"123"</span>[..]));
<span class="kw">let</span> <span class="ident">cstr</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul</span>(<span class="ident">data</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cstr</span>.<span class="ident">map</span>(<span class="ident">CStr</span>::<span class="ident">to_bytes_with_nul</span>), <span class="prelude-val">Ok</span>(<span class="kw-2">&</span><span class="string">b"123\0"</span>[..]));
<span class="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">cstr</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul</span>(<span class="ident">data</span>);
<span class="kw">let</span> <span class="ident">cstr_unchecked</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul_unchecked</span>(<span class="ident">data</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cstr</span>, <span class="prelude-val">Ok</span>(<span class="ident">cstr_unchecked</span>));
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">from_bytes_with_nul_unterminated</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"123"</span>;
<span class="kw">let</span> <span class="ident">cstr</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul</span>(<span class="ident">data</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">cstr</span>.<span class="ident">is_err</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">from_bytes_with_nul_interior</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="string">b"1\023\0"</span>;
<span class="kw">let</span> <span class="ident">cstr</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul</span>(<span class="ident">data</span>);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">cstr</span>.<span class="ident">is_err</span>());
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">into_boxed</span>() {
<span class="kw">let</span> <span class="ident">orig</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>] <span class="op">=</span> <span class="string">b"Hello, world!\0"</span>;
<span class="kw">let</span> <span class="ident">cstr</span> <span class="op">=</span> <span class="ident">CStr</span>::<span class="ident">from_bytes_with_nul</span>(<span class="ident">orig</span>).<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">boxed</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">></span> <span class="op">=</span> <span class="ident">Box</span>::<span class="ident">from</span>(<span class="ident">cstr</span>);
<span class="kw">let</span> <span class="ident">cstring</span> <span class="op">=</span> <span class="ident">cstr</span>.<span class="ident">to_owned</span>().<span class="ident">into_boxed_c_str</span>().<span class="ident">into_c_string</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">cstr</span>, <span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">boxed</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">boxed</span>, <span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">cstring</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">cstring</span>, <span class="ident">cstr</span>);
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">boxed_default</span>() {
<span class="kw">let</span> <span class="ident">boxed</span> <span class="op">=</span> <span class="op"><</span><span class="ident">Box</span><span class="op"><</span><span class="ident">CStr</span><span class="op">>></span>::<span class="ident">default</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">boxed</span>.<span class="ident">to_bytes_with_nul</span>(), <span class="kw-2">&</span>[<span class="number">0</span>]);
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "std";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
564935689ab5527f955e5449ded02799
>
files
>
2715
