blob: ef06de93d88ff3742c4abdc6300990657e3c9403 [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/conf.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>conf.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>
</pre><pre class="rust"><code><span class="doccomment">//! Interface for processing OpenSSL configuration files.
</span><span class="macro">foreign_type_and_impl_send_sync! </span>{
<span class="kw">type </span>CType = ffi::CONF;
<span class="kw">fn </span>drop = ffi::NCONF_free;
<span class="kw">pub struct </span>Conf;
<span class="kw">pub struct </span>ConfRef;
}
<span class="attribute">#[cfg(not(boringssl))]
</span><span class="kw">mod </span>methods {
<span class="kw">use </span><span class="kw">super</span>::Conf;
<span class="kw">use </span><span class="kw">crate</span>::cvt_p;
<span class="kw">use </span><span class="kw">crate</span>::error::ErrorStack;
<span class="kw">use </span>openssl_macros::corresponds;
<span class="kw">pub struct </span>ConfMethod(<span class="kw-2">*mut </span>ffi::CONF_METHOD);
<span class="kw">impl </span>ConfMethod {
<span class="doccomment">/// Retrieve handle to the default OpenSSL configuration file processing function.
</span><span class="attribute">#[corresponds(NCONF_default)]
#[allow(clippy::should_implement_trait)]
</span><span class="kw">pub fn </span>default() -&gt; ConfMethod {
<span class="kw">unsafe </span>{
ffi::init();
<span class="comment">// `NCONF` stands for &quot;New Conf&quot;, as described in crypto/conf/conf_lib.c. This is
// a newer API than the &quot;CONF classic&quot; functions.
</span>ConfMethod(ffi::NCONF_default())
}
}
<span class="doccomment">/// Construct from raw pointer.
///
/// # Safety
///
/// The caller must ensure that the pointer is valid.
</span><span class="kw">pub unsafe fn </span>from_ptr(ptr: <span class="kw-2">*mut </span>ffi::CONF_METHOD) -&gt; ConfMethod {
ConfMethod(ptr)
}
<span class="doccomment">/// Convert to raw pointer.
</span><span class="kw">pub fn </span>as_ptr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">*mut </span>ffi::CONF_METHOD {
<span class="self">self</span>.<span class="number">0
</span>}
}
<span class="kw">impl </span>Conf {
<span class="doccomment">/// Create a configuration parser.
///
/// # Examples
///
/// ```
/// use openssl::conf::{Conf, ConfMethod};
///
/// let conf = Conf::new(ConfMethod::default());
/// ```
</span><span class="attribute">#[corresponds(NCONF_new)]
</span><span class="kw">pub fn </span>new(method: ConfMethod) -&gt; <span class="prelude-ty">Result</span>&lt;Conf, ErrorStack&gt; {
<span class="kw">unsafe </span>{ cvt_p(ffi::NCONF_new(method.as_ptr())).map(Conf) }
}
}
}
<span class="attribute">#[cfg(not(boringssl))]
</span><span class="kw">pub use </span>methods::<span class="kw-2">*</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>