126 lines
15 KiB
HTML
126 lines
15 KiB
HTML
<!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 of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/tinystr-0.8.2/src/ule.rs`."><title>ule.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tinystr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">tinystr/</div>ule.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// This file is part of ICU4X. For terms of use, please see the file
|
|
<a href=#2 id=2 data-nosnippet>2</a>// called LICENSE at the top level of the ICU4X source tree
|
|
<a href=#3 id=3 data-nosnippet>3</a>// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
|
|
<a href=#4 id=4 data-nosnippet>4</a>
|
|
<a href=#5 id=5 data-nosnippet>5</a></span><span class="kw">use crate</span>::{TinyAsciiStr, UnvalidatedTinyAsciiStr};
|
|
<a href=#6 id=6 data-nosnippet>6</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
|
|
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">use </span>zerovec::maps::ZeroMapKV;
|
|
<a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>zerovec::ule::<span class="kw-2">*</span>;
|
|
<a href=#9 id=9 data-nosnippet>9</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
|
|
<a href=#10 id=10 data-nosnippet>10</a></span><span class="kw">use </span>zerovec::{ZeroSlice, ZeroVec};
|
|
<a href=#11 id=11 data-nosnippet>11</a>
|
|
<a href=#12 id=12 data-nosnippet>12</a><span class="comment">// Safety (based on the safety checklist on the ULE trait):
|
|
<a href=#13 id=13 data-nosnippet>13</a>// 1. TinyAsciiStr does not include any uninitialized or padding bytes.
|
|
<a href=#14 id=14 data-nosnippet>14</a>// (achieved by `#[repr(transparent)]` on a type that satisfies this invariant)
|
|
<a href=#15 id=15 data-nosnippet>15</a>// 2. TinyAsciiStr is aligned to 1 byte.
|
|
<a href=#16 id=16 data-nosnippet>16</a>// (achieved by `#[repr(transparent)]` on a type that satisfies this invariant)
|
|
<a href=#17 id=17 data-nosnippet>17</a>// 3. The impl of validate_bytes() returns an error if any byte is not valid.
|
|
<a href=#18 id=18 data-nosnippet>18</a>// 4. The impl of validate_bytes() returns an error if there are extra bytes.
|
|
<a href=#19 id=19 data-nosnippet>19</a>// 5. The other ULE methods use the default impl.
|
|
<a href=#20 id=20 data-nosnippet>20</a>// 6. TinyAsciiStr byte equality is semantic equality
|
|
<a href=#21 id=21 data-nosnippet>21</a></span><span class="kw">unsafe impl</span><<span class="kw">const </span>N: usize> ULE <span class="kw">for </span>TinyAsciiStr<N> {
|
|
<a href=#22 id=22 data-nosnippet>22</a> <span class="attr">#[inline]
|
|
<a href=#23 id=23 data-nosnippet>23</a> </span><span class="kw">fn </span>validate_bytes(bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><(), UleError> {
|
|
<a href=#24 id=24 data-nosnippet>24</a> <span class="kw">if </span>bytes.len() % <span class="macro">N !</span>= <span class="number">0 </span>{
|
|
<a href=#25 id=25 data-nosnippet>25</a> <span class="kw">return </span><span class="prelude-val">Err</span>(UleError::length::<<span class="self">Self</span>>(bytes.len()));
|
|
<a href=#26 id=26 data-nosnippet>26</a> }
|
|
<a href=#27 id=27 data-nosnippet>27</a> <span class="comment">// Validate the bytes
|
|
<a href=#28 id=28 data-nosnippet>28</a> </span><span class="kw">for </span>chunk <span class="kw">in </span>bytes.chunks_exact(N) {
|
|
<a href=#29 id=29 data-nosnippet>29</a> <span class="kw">let _ </span>= TinyAsciiStr::<N>::try_from_utf8_inner(chunk, <span class="bool-val">true</span>)
|
|
<a href=#30 id=30 data-nosnippet>30</a> .map_err(|<span class="kw">_</span>| UleError::parse::<<span class="self">Self</span>>())<span class="question-mark">?</span>;
|
|
<a href=#31 id=31 data-nosnippet>31</a> }
|
|
<a href=#32 id=32 data-nosnippet>32</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#33 id=33 data-nosnippet>33</a> }
|
|
<a href=#34 id=34 data-nosnippet>34</a>}
|
|
<a href=#35 id=35 data-nosnippet>35</a>
|
|
<a href=#36 id=36 data-nosnippet>36</a><span class="kw">impl</span><<span class="kw">const </span>N: usize> NicheBytes<N> <span class="kw">for </span>TinyAsciiStr<N> {
|
|
<a href=#37 id=37 data-nosnippet>37</a> <span class="comment">// AsciiByte is 0..128
|
|
<a href=#38 id=38 data-nosnippet>38</a> </span><span class="kw">const </span>NICHE_BIT_PATTERN: [u8; N] = [<span class="number">255</span>; N];
|
|
<a href=#39 id=39 data-nosnippet>39</a>}
|
|
<a href=#40 id=40 data-nosnippet>40</a>
|
|
<a href=#41 id=41 data-nosnippet>41</a><span class="kw">impl</span><<span class="kw">const </span>N: usize> AsULE <span class="kw">for </span>TinyAsciiStr<N> {
|
|
<a href=#42 id=42 data-nosnippet>42</a> <span class="kw">type </span>ULE = <span class="self">Self</span>;
|
|
<a href=#43 id=43 data-nosnippet>43</a>
|
|
<a href=#44 id=44 data-nosnippet>44</a> <span class="attr">#[inline]
|
|
<a href=#45 id=45 data-nosnippet>45</a> </span><span class="kw">fn </span>to_unaligned(<span class="self">self</span>) -> <span class="self">Self</span>::ULE {
|
|
<a href=#46 id=46 data-nosnippet>46</a> <span class="self">self
|
|
<a href=#47 id=47 data-nosnippet>47</a> </span>}
|
|
<a href=#48 id=48 data-nosnippet>48</a>
|
|
<a href=#49 id=49 data-nosnippet>49</a> <span class="attr">#[inline]
|
|
<a href=#50 id=50 data-nosnippet>50</a> </span><span class="kw">fn </span>from_unaligned(unaligned: <span class="self">Self</span>::ULE) -> <span class="self">Self </span>{
|
|
<a href=#51 id=51 data-nosnippet>51</a> unaligned
|
|
<a href=#52 id=52 data-nosnippet>52</a> }
|
|
<a href=#53 id=53 data-nosnippet>53</a>}
|
|
<a href=#54 id=54 data-nosnippet>54</a>
|
|
<a href=#55 id=55 data-nosnippet>55</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
|
|
<a href=#56 id=56 data-nosnippet>56</a></span><span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="kw">const </span>N: usize> ZeroMapKV<<span class="lifetime">'a</span>> <span class="kw">for </span>TinyAsciiStr<N> {
|
|
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">type </span>Container = ZeroVec<<span class="lifetime">'a</span>, TinyAsciiStr<N>>;
|
|
<a href=#58 id=58 data-nosnippet>58</a> <span class="kw">type </span>Slice = ZeroSlice<TinyAsciiStr<N>>;
|
|
<a href=#59 id=59 data-nosnippet>59</a> <span class="kw">type </span>GetType = TinyAsciiStr<N>;
|
|
<a href=#60 id=60 data-nosnippet>60</a> <span class="kw">type </span>OwnedType = TinyAsciiStr<N>;
|
|
<a href=#61 id=61 data-nosnippet>61</a>}
|
|
<a href=#62 id=62 data-nosnippet>62</a>
|
|
<a href=#63 id=63 data-nosnippet>63</a><span class="comment">// Safety (based on the safety checklist on the ULE trait):
|
|
<a href=#64 id=64 data-nosnippet>64</a>// 1. UnvalidatedTinyAsciiStr does not include any uninitialized or padding bytes.
|
|
<a href=#65 id=65 data-nosnippet>65</a>// (achieved by `#[repr(transparent)]` on a type that satisfies this invariant)
|
|
<a href=#66 id=66 data-nosnippet>66</a>// 2. UnvalidatedTinyAsciiStr is aligned to 1 byte.
|
|
<a href=#67 id=67 data-nosnippet>67</a>// (achieved by `#[repr(transparent)]` on a type that satisfies this invariant)
|
|
<a href=#68 id=68 data-nosnippet>68</a>// 3. The impl of validate_bytes() returns an error if any byte is not valid.
|
|
<a href=#69 id=69 data-nosnippet>69</a>// 4. The impl of validate_bytes() returns an error if there are extra bytes.
|
|
<a href=#70 id=70 data-nosnippet>70</a>// 5. The other ULE methods use the default impl.
|
|
<a href=#71 id=71 data-nosnippet>71</a>// 6. UnvalidatedTinyAsciiStr byte equality is semantic equality
|
|
<a href=#72 id=72 data-nosnippet>72</a></span><span class="kw">unsafe impl</span><<span class="kw">const </span>N: usize> ULE <span class="kw">for </span>UnvalidatedTinyAsciiStr<N> {
|
|
<a href=#73 id=73 data-nosnippet>73</a> <span class="attr">#[inline]
|
|
<a href=#74 id=74 data-nosnippet>74</a> </span><span class="kw">fn </span>validate_bytes(bytes: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><(), UleError> {
|
|
<a href=#75 id=75 data-nosnippet>75</a> <span class="kw">if </span>bytes.len() % <span class="macro">N !</span>= <span class="number">0 </span>{
|
|
<a href=#76 id=76 data-nosnippet>76</a> <span class="kw">return </span><span class="prelude-val">Err</span>(UleError::length::<<span class="self">Self</span>>(bytes.len()));
|
|
<a href=#77 id=77 data-nosnippet>77</a> }
|
|
<a href=#78 id=78 data-nosnippet>78</a> <span class="prelude-val">Ok</span>(())
|
|
<a href=#79 id=79 data-nosnippet>79</a> }
|
|
<a href=#80 id=80 data-nosnippet>80</a>}
|
|
<a href=#81 id=81 data-nosnippet>81</a>
|
|
<a href=#82 id=82 data-nosnippet>82</a><span class="kw">impl</span><<span class="kw">const </span>N: usize> AsULE <span class="kw">for </span>UnvalidatedTinyAsciiStr<N> {
|
|
<a href=#83 id=83 data-nosnippet>83</a> <span class="kw">type </span>ULE = <span class="self">Self</span>;
|
|
<a href=#84 id=84 data-nosnippet>84</a>
|
|
<a href=#85 id=85 data-nosnippet>85</a> <span class="attr">#[inline]
|
|
<a href=#86 id=86 data-nosnippet>86</a> </span><span class="kw">fn </span>to_unaligned(<span class="self">self</span>) -> <span class="self">Self</span>::ULE {
|
|
<a href=#87 id=87 data-nosnippet>87</a> <span class="self">self
|
|
<a href=#88 id=88 data-nosnippet>88</a> </span>}
|
|
<a href=#89 id=89 data-nosnippet>89</a>
|
|
<a href=#90 id=90 data-nosnippet>90</a> <span class="attr">#[inline]
|
|
<a href=#91 id=91 data-nosnippet>91</a> </span><span class="kw">fn </span>from_unaligned(unaligned: <span class="self">Self</span>::ULE) -> <span class="self">Self </span>{
|
|
<a href=#92 id=92 data-nosnippet>92</a> unaligned
|
|
<a href=#93 id=93 data-nosnippet>93</a> }
|
|
<a href=#94 id=94 data-nosnippet>94</a>}
|
|
<a href=#95 id=95 data-nosnippet>95</a>
|
|
<a href=#96 id=96 data-nosnippet>96</a><span class="attr">#[cfg(feature = <span class="string">"alloc"</span>)]
|
|
<a href=#97 id=97 data-nosnippet>97</a></span><span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="kw">const </span>N: usize> ZeroMapKV<<span class="lifetime">'a</span>> <span class="kw">for </span>UnvalidatedTinyAsciiStr<N> {
|
|
<a href=#98 id=98 data-nosnippet>98</a> <span class="kw">type </span>Container = ZeroVec<<span class="lifetime">'a</span>, UnvalidatedTinyAsciiStr<N>>;
|
|
<a href=#99 id=99 data-nosnippet>99</a> <span class="kw">type </span>Slice = ZeroSlice<UnvalidatedTinyAsciiStr<N>>;
|
|
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">type </span>GetType = UnvalidatedTinyAsciiStr<N>;
|
|
<a href=#101 id=101 data-nosnippet>101</a> <span class="kw">type </span>OwnedType = UnvalidatedTinyAsciiStr<N>;
|
|
<a href=#102 id=102 data-nosnippet>102</a>}
|
|
<a href=#103 id=103 data-nosnippet>103</a>
|
|
<a href=#104 id=104 data-nosnippet>104</a><span class="attr">#[cfg(test)]
|
|
<a href=#105 id=105 data-nosnippet>105</a></span><span class="kw">mod </span>test {
|
|
<a href=#106 id=106 data-nosnippet>106</a> <span class="kw">use crate</span>::<span class="kw-2">*</span>;
|
|
<a href=#107 id=107 data-nosnippet>107</a> <span class="kw">use </span>zerovec::<span class="kw-2">*</span>;
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a> <span class="attr">#[test]
|
|
<a href=#110 id=110 data-nosnippet>110</a> </span><span class="kw">fn </span>test_zerovec() {
|
|
<a href=#111 id=111 data-nosnippet>111</a> <span class="kw">let </span><span class="kw-2">mut </span>vec = ZeroVec::<TinyAsciiStr<<span class="number">7</span>>>::new();
|
|
<a href=#112 id=112 data-nosnippet>112</a>
|
|
<a href=#113 id=113 data-nosnippet>113</a> vec.with_mut(|v| v.push(<span class="string">"foobar"</span>.parse().unwrap()));
|
|
<a href=#114 id=114 data-nosnippet>114</a> vec.with_mut(|v| v.push(<span class="string">"baz"</span>.parse().unwrap()));
|
|
<a href=#115 id=115 data-nosnippet>115</a> vec.with_mut(|v| v.push(<span class="string">"quux"</span>.parse().unwrap()));
|
|
<a href=#116 id=116 data-nosnippet>116</a>
|
|
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">let </span>bytes = vec.as_bytes();
|
|
<a href=#118 id=118 data-nosnippet>118</a>
|
|
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">let </span>vec: ZeroVec<TinyAsciiStr<<span class="number">7</span>>> = ZeroVec::parse_bytes(bytes).unwrap();
|
|
<a href=#120 id=120 data-nosnippet>120</a>
|
|
<a href=#121 id=121 data-nosnippet>121</a> <span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>vec.get(<span class="number">0</span>).unwrap(), <span class="string">"foobar"</span>);
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>vec.get(<span class="number">1</span>).unwrap(), <span class="string">"baz"</span>);
|
|
<a href=#123 id=123 data-nosnippet>123</a> <span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>vec.get(<span class="number">2</span>).unwrap(), <span class="string">"quux"</span>);
|
|
<a href=#124 id=124 data-nosnippet>124</a> }
|
|
<a href=#125 id=125 data-nosnippet>125</a>}
|
|
</code></pre></div></section></main></body></html> |