blob: a267b379e6b4e21252951ab956c9b18b4d482302 [file] [log] [blame]
<!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 `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/openssl-0.10.54/src/version.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>version.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../openssl/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../openssl/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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>
</pre><pre class="rust"><code><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
</span><span class="doccomment">//! Build and version information.
</span><span class="kw">use </span>cfg_if::cfg_if;
<span class="kw">use </span>openssl_macros::corresponds;
<span class="kw">use </span>std::ffi::CStr;
<span class="macro">cfg_if! </span>{
<span class="kw">if </span><span class="attribute">#[cfg(any(ossl110, libressl271))] </span>{
<span class="kw">use </span>ffi::{
OPENSSL_VERSION, OPENSSL_CFLAGS, OPENSSL_BUILT_ON, OPENSSL_PLATFORM, OPENSSL_DIR,
OpenSSL_version_num, OpenSSL_version,
};
} <span class="kw">else </span>{
<span class="kw">use </span>ffi::{
SSLEAY_VERSION <span class="kw">as </span>OPENSSL_VERSION, SSLEAY_CFLAGS <span class="kw">as </span>OPENSSL_CFLAGS,
SSLEAY_BUILT_ON <span class="kw">as </span>OPENSSL_BUILT_ON, SSLEAY_PLATFORM <span class="kw">as </span>OPENSSL_PLATFORM,
SSLEAY_DIR <span class="kw">as </span>OPENSSL_DIR, SSLeay <span class="kw">as </span>OpenSSL_version_num,
SSLeay_version <span class="kw">as </span>OpenSSL_version,
};
}
}
<span class="doccomment">/// OPENSSL_VERSION_NUMBER is a numeric release version identifier:
///
/// `MNNFFPPS: major minor fix patch status`
///
/// The status nibble has one of the values 0 for development, 1 to e for betas 1 to 14, and f for release.
///
/// for example
///
/// `0x000906000 == 0.9.6 dev`
/// `0x000906023 == 0.9.6b beta 3`
/// `0x00090605f == 0.9.6e release`
</span><span class="attribute">#[corresponds(OpenSSL_version_num)]
</span><span class="kw">pub fn </span>number() -&gt; i64 {
<span class="kw">unsafe </span>{ OpenSSL_version_num() <span class="kw">as </span>i64 }
}
<span class="doccomment">/// The text variant of the version number and the release date. For example, &quot;OpenSSL 0.9.5a 1 Apr 2000&quot;.
</span><span class="attribute">#[corresponds(OpenSSL_version)]
</span><span class="kw">pub fn </span>version() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="kw">unsafe </span>{
CStr::from_ptr(OpenSSL_version(OPENSSL_VERSION))
.to_str()
.unwrap()
}
}
<span class="doccomment">/// The compiler flags set for the compilation process in the form &quot;compiler: ...&quot; if available or
/// &quot;compiler: information not available&quot; otherwise.
</span><span class="attribute">#[corresponds(OpenSSL_version)]
</span><span class="kw">pub fn </span>c_flags() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="kw">unsafe </span>{
CStr::from_ptr(OpenSSL_version(OPENSSL_CFLAGS))
.to_str()
.unwrap()
}
}
<span class="doccomment">/// The date of the build process in the form &quot;built on: ...&quot; if available or &quot;built on: date not available&quot; otherwise.
</span><span class="attribute">#[corresponds(OpenSSL_version)]
</span><span class="kw">pub fn </span>built_on() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="kw">unsafe </span>{
CStr::from_ptr(OpenSSL_version(OPENSSL_BUILT_ON))
.to_str()
.unwrap()
}
}
<span class="doccomment">/// The &quot;Configure&quot; target of the library build in the form &quot;platform: ...&quot; if available or &quot;platform: information not available&quot; otherwise.
</span><span class="attribute">#[corresponds(OpenSSL_version)]
</span><span class="kw">pub fn </span>platform() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="kw">unsafe </span>{
CStr::from_ptr(OpenSSL_version(OPENSSL_PLATFORM))
.to_str()
.unwrap()
}
}
<span class="doccomment">/// The &quot;OPENSSLDIR&quot; setting of the library build in the form &quot;OPENSSLDIR: &quot;...&quot;&quot; if available or &quot;OPENSSLDIR: N/A&quot; otherwise.
</span><span class="attribute">#[corresponds(OpenSSL_version)]
</span><span class="kw">pub fn </span>dir() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="kw">unsafe </span>{
CStr::from_ptr(OpenSSL_version(OPENSSL_DIR))
.to_str()
.unwrap()
}
}
<span class="doccomment">/// This test ensures that we do not segfault when calling the functions of this module
/// and that the strings respect a reasonable format.
</span><span class="attribute">#[test]
</span><span class="kw">fn </span>test_versions() {
<span class="macro">println!</span>(<span class="string">&quot;Number: &#39;{}&#39;&quot;</span>, number());
<span class="macro">println!</span>(<span class="string">&quot;Version: &#39;{}&#39;&quot;</span>, version());
<span class="macro">println!</span>(<span class="string">&quot;C flags: &#39;{}&#39;&quot;</span>, c_flags());
<span class="macro">println!</span>(<span class="string">&quot;Built on: &#39;{}&#39;&quot;</span>, built_on());
<span class="macro">println!</span>(<span class="string">&quot;Platform: &#39;{}&#39;&quot;</span>, platform());
<span class="macro">println!</span>(<span class="string">&quot;Dir: &#39;{}&#39;&quot;</span>, dir());
<span class="attribute">#[cfg(not(any(libressl, boringssl)))]
</span><span class="kw">fn </span>expected_name() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="string">&quot;OpenSSL&quot;
</span>}
<span class="attribute">#[cfg(libressl)]
</span><span class="kw">fn </span>expected_name() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="string">&quot;LibreSSL&quot;
</span>}
<span class="attribute">#[cfg(boringssl)]
</span><span class="kw">fn </span>expected_name() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="string">&quot;BoringSSL&quot;
</span>}
<span class="macro">assert!</span>(number() &gt; <span class="number">0</span>);
<span class="macro">assert!</span>(version().starts_with(expected_name()));
<span class="macro">assert!</span>(c_flags().starts_with(<span class="string">&quot;compiler:&quot;</span>));
<span class="comment">// some distributions patch out dates out of openssl so that the builds are reproducible
</span><span class="kw">if </span>!built_on().is_empty() {
<span class="macro">assert!</span>(built_on().starts_with(<span class="string">&quot;built on:&quot;</span>));
}
<span class="macro">assert!</span>(dir().starts_with(<span class="string">&quot;OPENSSLDIR:&quot;</span>));
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="openssl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>