14 lines
4.6 KiB
HTML
14 lines
4.6 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="Probe for SSL certificates on the system, then configure the SSL certificate `SSL_CERT_FILE` and `SSL_CERT_DIR` environment variables in this process for OpenSSL to use."><title>try_init_openssl_env_vars in openssl_probe - Rust</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="openssl_probe" 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="sidebar-items.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 fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">try_init_openssl_env_vars</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../openssl_probe/index.html">openssl_<wbr>probe</a><span class="version">0.2.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">try_<wbr>init_<wbr>openssl_<wbr>env_<wbr>vars</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate openssl_<wbr>probe</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">openssl_probe</a></div><h1>Function <span class="fn">try_<wbr>init_<wbr>openssl_<wbr>env_<wbr>vars</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/openssl_probe/lib.rs.html#25-64">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe fn try_init_openssl_env_vars() -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Probe for SSL certificates on the system, then configure the SSL certificate <code>SSL_CERT_FILE</code>
|
||
and <code>SSL_CERT_DIR</code> environment variables in this process for OpenSSL to use.</p>
|
||
<p>Preconfigured values in the environment variables will not be overwritten if the paths they
|
||
point to exist and are accessible.</p>
|
||
<p>Returns <code>true</code> if any certificate file or directory was found while probing.
|
||
Combine this with <code>has_ssl_cert_env_vars()</code> to check whether previously configured environment
|
||
variables are valid.</p>
|
||
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
|
||
<p>This function is not safe because it mutates the process’s environment
|
||
variables which is generally not safe. See the <a href="https://doc.rust-lang.org/stable/std/env/fn.set_var.html#safety">documentation in libstd</a>
|
||
for information about why setting environment variables is not safe.</p>
|
||
<p>If possible use the <a href="fn.probe.html" title="fn openssl_probe::probe"><code>probe</code></a> function and directly configure OpenSSL
|
||
methods instead of relying on environment variables.</p>
|
||
</div></details></section></div></main></body></html> |