/
fn.get.html
24 lines (23 loc) · 5.46 KB
/
fn.get.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<!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="API documentation for the Rust `get` fn in crate `ci_info`."><meta name="keywords" content="rust, rustlang, rust-lang, get"><title>ci_info::get - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../ci_info/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>ci_info</a></p><script>window.sidebarCurrent = {name: 'get', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/ci_info/lib.rs.html#265-267' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>ci_info</a>::<wbr><a class="fn" href=''>get</a></span></h1><pre class='rust fn'>pub fn get() -> <a class="struct" href="../ci_info/types/struct.CiInfo.html" title="struct ci_info::types::CiInfo">CiInfo</a></pre><div class='docblock'><p>Loads and returns the CI info of the current environment.</p>
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="comment">// Just check if a CI environment is detected.</span>
<span class="kw">let</span> <span class="ident">ci</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">is_ci</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is CI: {}"</span>, <span class="ident">ci</span>);
<span class="comment">// Get CI environment information</span>
<span class="kw">let</span> <span class="ident">info</span> <span class="op">=</span> <span class="ident">ci_info</span>::<span class="ident">get</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is CI: {}"</span>, <span class="ident">info</span>.<span class="ident">ci</span>);
<span class="kw">if</span> <span class="ident">info</span>.<span class="ident">vendor</span>.<span class="ident">is_some</span>() {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Vendor: {:#?}"</span>, <span class="ident">info</span>.<span class="ident">vendor</span>.<span class="ident">unwrap</span>());
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Name: {:#?}"</span>, <span class="ident">info</span>.<span class="ident">name</span>.<span class="ident">unwrap</span>());
}
<span class="kw">if</span> <span class="ident">info</span>.<span class="ident">pr</span>.<span class="ident">is_some</span>() {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Is PR: {:#?}"</span>, <span class="ident">info</span>.<span class="ident">pr</span>.<span class="ident">unwrap</span>());
}
<span class="kw">if</span> <span class="ident">info</span>.<span class="ident">branch_name</span>.<span class="ident">is_some</span>() {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Branch Name: {:#?}"</span>, <span class="ident">info</span>.<span class="ident">branch_name</span>.<span class="ident">unwrap</span>());
}
}</pre></div>
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "ci_info";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>