161 lines
16 KiB
HTML
161 lines
16 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/errno-0.3.14/src/lib.rs`."><title>lib.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="errno" 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">errno/</div>lib.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="doccomment">//! Cross-platform interface to the `errno` variable.
|
|
<a href=#2 id=2 data-nosnippet>2</a>//!
|
|
<a href=#3 id=3 data-nosnippet>3</a>//! # Examples
|
|
<a href=#4 id=4 data-nosnippet>4</a>//! ```
|
|
<a href=#5 id=5 data-nosnippet>5</a>//! use errno::{Errno, errno, set_errno};
|
|
<a href=#6 id=6 data-nosnippet>6</a>//!
|
|
<a href=#7 id=7 data-nosnippet>7</a>//! // Get the current value of errno
|
|
<a href=#8 id=8 data-nosnippet>8</a>//! let e = errno();
|
|
<a href=#9 id=9 data-nosnippet>9</a>//!
|
|
<a href=#10 id=10 data-nosnippet>10</a>//! // Set the current value of errno
|
|
<a href=#11 id=11 data-nosnippet>11</a>//! set_errno(e);
|
|
<a href=#12 id=12 data-nosnippet>12</a>//!
|
|
<a href=#13 id=13 data-nosnippet>13</a>//! // Extract the error code as an i32
|
|
<a href=#14 id=14 data-nosnippet>14</a>//! let code = e.0;
|
|
<a href=#15 id=15 data-nosnippet>15</a>//!
|
|
<a href=#16 id=16 data-nosnippet>16</a>//! // Display a human-friendly error message
|
|
<a href=#17 id=17 data-nosnippet>17</a>//! println!("Error {}: {}", code, e);
|
|
<a href=#18 id=18 data-nosnippet>18</a>//! ```
|
|
<a href=#19 id=19 data-nosnippet>19</a>
|
|
<a href=#20 id=20 data-nosnippet>20</a></span><span class="attr">#![cfg_attr(not(feature = <span class="string">"std"</span>), no_std)]
|
|
<a href=#21 id=21 data-nosnippet>21</a>
|
|
<a href=#22 id=22 data-nosnippet>22</a>#[cfg_attr(unix, path = <span class="string">"unix.rs"</span>)]
|
|
<a href=#23 id=23 data-nosnippet>23</a>#[cfg_attr(windows, path = <span class="string">"windows.rs"</span>)]
|
|
<a href=#24 id=24 data-nosnippet>24</a>#[cfg_attr(target_os = <span class="string">"wasi"</span>, path = <span class="string">"wasi.rs"</span>)]
|
|
<a href=#25 id=25 data-nosnippet>25</a>#[cfg_attr(target_os = <span class="string">"hermit"</span>, path = <span class="string">"hermit.rs"</span>)]
|
|
<a href=#26 id=26 data-nosnippet>26</a></span><span class="kw">mod </span>sys;
|
|
<a href=#27 id=27 data-nosnippet>27</a>
|
|
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span>core::fmt;
|
|
<a href=#29 id=29 data-nosnippet>29</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#30 id=30 data-nosnippet>30</a></span><span class="kw">use </span>std::error::Error;
|
|
<a href=#31 id=31 data-nosnippet>31</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#32 id=32 data-nosnippet>32</a></span><span class="kw">use </span>std::io;
|
|
<a href=#33 id=33 data-nosnippet>33</a>
|
|
<a href=#34 id=34 data-nosnippet>34</a><span class="doccomment">/// Wraps a platform-specific error code.
|
|
<a href=#35 id=35 data-nosnippet>35</a>///
|
|
<a href=#36 id=36 data-nosnippet>36</a>/// The `Display` instance maps the code to a human-readable string. It
|
|
<a href=#37 id=37 data-nosnippet>37</a>/// calls [`strerror_r`][1] under POSIX, and [`FormatMessageW`][2] on
|
|
<a href=#38 id=38 data-nosnippet>38</a>/// Windows.
|
|
<a href=#39 id=39 data-nosnippet>39</a>///
|
|
<a href=#40 id=40 data-nosnippet>40</a>/// [1]: http://pubs.opengroup.org/onlinepubs/009695399/functions/strerror.html
|
|
<a href=#41 id=41 data-nosnippet>41</a>/// [2]: https://msdn.microsoft.com/en-us/library/windows/desktop/ms679351%28v=vs.85%29.aspx
|
|
<a href=#42 id=42 data-nosnippet>42</a></span><span class="attr">#[derive(Copy, Clone, Eq, Ord, PartialEq, PartialOrd, Hash)]
|
|
<a href=#43 id=43 data-nosnippet>43</a></span><span class="kw">pub struct </span>Errno(<span class="kw">pub </span>i32);
|
|
<a href=#44 id=44 data-nosnippet>44</a>
|
|
<a href=#45 id=45 data-nosnippet>45</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Errno {
|
|
<a href=#46 id=46 data-nosnippet>46</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#47 id=47 data-nosnippet>47</a> sys::with_description(<span class="kw-2">*</span><span class="self">self</span>, |desc| {
|
|
<a href=#48 id=48 data-nosnippet>48</a> fmt.debug_struct(<span class="string">"Errno"</span>)
|
|
<a href=#49 id=49 data-nosnippet>49</a> .field(<span class="string">"code"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>)
|
|
<a href=#50 id=50 data-nosnippet>50</a> .field(<span class="string">"description"</span>, <span class="kw-2">&</span>desc.ok())
|
|
<a href=#51 id=51 data-nosnippet>51</a> .finish()
|
|
<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>
|
|
<a href=#56 id=56 data-nosnippet>56</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>Errno {
|
|
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result {
|
|
<a href=#58 id=58 data-nosnippet>58</a> sys::with_description(<span class="kw-2">*</span><span class="self">self</span>, |desc| <span class="kw">match </span>desc {
|
|
<a href=#59 id=59 data-nosnippet>59</a> <span class="prelude-val">Ok</span>(desc) => fmt.write_str(desc),
|
|
<a href=#60 id=60 data-nosnippet>60</a> <span class="prelude-val">Err</span>(fm_err) => <span class="macro">write!</span>(
|
|
<a href=#61 id=61 data-nosnippet>61</a> fmt,
|
|
<a href=#62 id=62 data-nosnippet>62</a> <span class="string">"OS error {} ({} returned error {})"</span>,
|
|
<a href=#63 id=63 data-nosnippet>63</a> <span class="self">self</span>.<span class="number">0</span>,
|
|
<a href=#64 id=64 data-nosnippet>64</a> sys::STRERROR_NAME,
|
|
<a href=#65 id=65 data-nosnippet>65</a> fm_err.<span class="number">0
|
|
<a href=#66 id=66 data-nosnippet>66</a> </span>),
|
|
<a href=#67 id=67 data-nosnippet>67</a> })
|
|
<a href=#68 id=68 data-nosnippet>68</a> }
|
|
<a href=#69 id=69 data-nosnippet>69</a>}
|
|
<a href=#70 id=70 data-nosnippet>70</a>
|
|
<a href=#71 id=71 data-nosnippet>71</a><span class="kw">impl </span>From<Errno> <span class="kw">for </span>i32 {
|
|
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">fn </span>from(e: Errno) -> <span class="self">Self </span>{
|
|
<a href=#73 id=73 data-nosnippet>73</a> e.<span class="number">0
|
|
<a href=#74 id=74 data-nosnippet>74</a> </span>}
|
|
<a href=#75 id=75 data-nosnippet>75</a>}
|
|
<a href=#76 id=76 data-nosnippet>76</a>
|
|
<a href=#77 id=77 data-nosnippet>77</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#78 id=78 data-nosnippet>78</a></span><span class="kw">impl </span>Error <span class="kw">for </span>Errno {
|
|
<a href=#79 id=79 data-nosnippet>79</a> <span class="comment">// TODO: Remove when MSRV >= 1.27
|
|
<a href=#80 id=80 data-nosnippet>80</a> </span><span class="attr">#[allow(deprecated)]
|
|
<a href=#81 id=81 data-nosnippet>81</a> </span><span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#82 id=82 data-nosnippet>82</a> <span class="string">"system error"
|
|
<a href=#83 id=83 data-nosnippet>83</a> </span>}
|
|
<a href=#84 id=84 data-nosnippet>84</a>}
|
|
<a href=#85 id=85 data-nosnippet>85</a>
|
|
<a href=#86 id=86 data-nosnippet>86</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#87 id=87 data-nosnippet>87</a></span><span class="kw">impl </span>From<Errno> <span class="kw">for </span>io::Error {
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">fn </span>from(errno: Errno) -> <span class="self">Self </span>{
|
|
<a href=#89 id=89 data-nosnippet>89</a> io::Error::from_raw_os_error(errno.<span class="number">0</span>)
|
|
<a href=#90 id=90 data-nosnippet>90</a> }
|
|
<a href=#91 id=91 data-nosnippet>91</a>}
|
|
<a href=#92 id=92 data-nosnippet>92</a>
|
|
<a href=#93 id=93 data-nosnippet>93</a><span class="doccomment">/// Returns the platform-specific value of `errno`.
|
|
<a href=#94 id=94 data-nosnippet>94</a></span><span class="kw">pub fn </span>errno() -> Errno {
|
|
<a href=#95 id=95 data-nosnippet>95</a> sys::errno()
|
|
<a href=#96 id=96 data-nosnippet>96</a>}
|
|
<a href=#97 id=97 data-nosnippet>97</a>
|
|
<a href=#98 id=98 data-nosnippet>98</a><span class="doccomment">/// Sets the platform-specific value of `errno`.
|
|
<a href=#99 id=99 data-nosnippet>99</a></span><span class="kw">pub fn </span>set_errno(err: Errno) {
|
|
<a href=#100 id=100 data-nosnippet>100</a> sys::set_errno(err)
|
|
<a href=#101 id=101 data-nosnippet>101</a>}
|
|
<a href=#102 id=102 data-nosnippet>102</a>
|
|
<a href=#103 id=103 data-nosnippet>103</a><span class="attr">#[test]
|
|
<a href=#104 id=104 data-nosnippet>104</a></span><span class="kw">fn </span>it_works() {
|
|
<a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span>x = errno();
|
|
<a href=#106 id=106 data-nosnippet>106</a> set_errno(x);
|
|
<a href=#107 id=107 data-nosnippet>107</a>}
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#110 id=110 data-nosnippet>110</a>#[test]
|
|
<a href=#111 id=111 data-nosnippet>111</a></span><span class="kw">fn </span>it_works_with_to_string() {
|
|
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">let </span>x = errno();
|
|
<a href=#113 id=113 data-nosnippet>113</a> <span class="kw">let _ </span>= x.to_string();
|
|
<a href=#114 id=114 data-nosnippet>114</a>}
|
|
<a href=#115 id=115 data-nosnippet>115</a>
|
|
<a href=#116 id=116 data-nosnippet>116</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#117 id=117 data-nosnippet>117</a>#[test]
|
|
<a href=#118 id=118 data-nosnippet>118</a></span><span class="kw">fn </span>check_description() {
|
|
<a href=#119 id=119 data-nosnippet>119</a> <span class="kw">let </span>expect = <span class="kw">if </span><span class="macro">cfg!</span>(windows) {
|
|
<a href=#120 id=120 data-nosnippet>120</a> <span class="string">"Incorrect function."
|
|
<a href=#121 id=121 data-nosnippet>121</a> </span>} <span class="kw">else if </span><span class="macro">cfg!</span>(target_os = <span class="string">"illumos"</span>) {
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="string">"Not owner"
|
|
<a href=#123 id=123 data-nosnippet>123</a> </span>} <span class="kw">else if </span><span class="macro">cfg!</span>(target_os = <span class="string">"wasi"</span>) || <span class="macro">cfg!</span>(target_os = <span class="string">"emscripten"</span>) {
|
|
<a href=#124 id=124 data-nosnippet>124</a> <span class="string">"Argument list too long"
|
|
<a href=#125 id=125 data-nosnippet>125</a> </span>} <span class="kw">else if </span><span class="macro">cfg!</span>(target_os = <span class="string">"haiku"</span>) {
|
|
<a href=#126 id=126 data-nosnippet>126</a> <span class="string">"Operation not allowed"
|
|
<a href=#127 id=127 data-nosnippet>127</a> </span>} <span class="kw">else if </span><span class="macro">cfg!</span>(target_os = <span class="string">"vxworks"</span>) {
|
|
<a href=#128 id=128 data-nosnippet>128</a> <span class="string">"operation not permitted"
|
|
<a href=#129 id=129 data-nosnippet>129</a> </span>} <span class="kw">else </span>{
|
|
<a href=#130 id=130 data-nosnippet>130</a> <span class="string">"Operation not permitted"
|
|
<a href=#131 id=131 data-nosnippet>131</a> </span>};
|
|
<a href=#132 id=132 data-nosnippet>132</a>
|
|
<a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let </span>errno_code = <span class="kw">if </span><span class="macro">cfg!</span>(target_os = <span class="string">"haiku"</span>) {
|
|
<a href=#134 id=134 data-nosnippet>134</a> -<span class="number">2147483633
|
|
<a href=#135 id=135 data-nosnippet>135</a> </span>} <span class="kw">else if </span><span class="macro">cfg!</span>(target_os = <span class="string">"hurd"</span>) {
|
|
<a href=#136 id=136 data-nosnippet>136</a> <span class="number">1073741825
|
|
<a href=#137 id=137 data-nosnippet>137</a> </span>} <span class="kw">else </span>{
|
|
<a href=#138 id=138 data-nosnippet>138</a> <span class="number">1
|
|
<a href=#139 id=139 data-nosnippet>139</a> </span>};
|
|
<a href=#140 id=140 data-nosnippet>140</a> set_errno(Errno(errno_code));
|
|
<a href=#141 id=141 data-nosnippet>141</a>
|
|
<a href=#142 id=142 data-nosnippet>142</a> <span class="macro">assert_eq!</span>(errno().to_string(), expect);
|
|
<a href=#143 id=143 data-nosnippet>143</a> <span class="macro">assert_eq!</span>(
|
|
<a href=#144 id=144 data-nosnippet>144</a> <span class="macro">format!</span>(<span class="string">"{:?}"</span>, errno()),
|
|
<a href=#145 id=145 data-nosnippet>145</a> <span class="macro">format!</span>(
|
|
<a href=#146 id=146 data-nosnippet>146</a> <span class="string">"Errno {{ code: {}, description: Some({:?}) }}"</span>,
|
|
<a href=#147 id=147 data-nosnippet>147</a> errno_code, expect
|
|
<a href=#148 id=148 data-nosnippet>148</a> )
|
|
<a href=#149 id=149 data-nosnippet>149</a> );
|
|
<a href=#150 id=150 data-nosnippet>150</a>}
|
|
<a href=#151 id=151 data-nosnippet>151</a>
|
|
<a href=#152 id=152 data-nosnippet>152</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#153 id=153 data-nosnippet>153</a>#[test]
|
|
<a href=#154 id=154 data-nosnippet>154</a></span><span class="kw">fn </span>check_error_into_errno() {
|
|
<a href=#155 id=155 data-nosnippet>155</a> <span class="kw">const </span>ERROR_CODE: i32 = <span class="number">1</span>;
|
|
<a href=#156 id=156 data-nosnippet>156</a>
|
|
<a href=#157 id=157 data-nosnippet>157</a> <span class="kw">let </span>error = io::Error::from_raw_os_error(ERROR_CODE);
|
|
<a href=#158 id=158 data-nosnippet>158</a> <span class="kw">let </span>new_error: io::Error = Errno(ERROR_CODE).into();
|
|
<a href=#159 id=159 data-nosnippet>159</a> <span class="macro">assert_eq!</span>(error.kind(), new_error.kind());
|
|
<a href=#160 id=160 data-nosnippet>160</a>}
|
|
</code></pre></div></section></main></body></html> |