3162 lines
179 KiB
HTML
3162 lines
179 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="Asciidoctor 2.0.26">
|
|
<meta name="author" content="Brent Saner">
|
|
<title>SprigX</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
|
|
<style>
|
|
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
|
|
/* Uncomment the following line when using as a custom stylesheet */
|
|
/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
|
|
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
|
|
a{background:none}
|
|
a:focus{outline:thin dotted}
|
|
a:active,a:hover{outline:0}
|
|
h1{font-size:2em;margin:.67em 0}
|
|
b,strong{font-weight:bold}
|
|
abbr{font-size:.9em}
|
|
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
|
|
dfn{font-style:italic}
|
|
hr{height:0}
|
|
mark{background:#ff0;color:#000}
|
|
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
|
pre{white-space:pre-wrap}
|
|
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
|
small{font-size:80%}
|
|
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
|
sup{top:-.5em}
|
|
sub{bottom:-.25em}
|
|
img{border:0}
|
|
svg:not(:root){overflow:hidden}
|
|
figure{margin:0}
|
|
audio,video{display:inline-block}
|
|
audio:not([controls]){display:none;height:0}
|
|
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
|
legend{border:0;padding:0}
|
|
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
|
button,input{line-height:normal}
|
|
button,select{text-transform:none}
|
|
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
|
|
button[disabled],html input[disabled]{cursor:default}
|
|
input[type=checkbox],input[type=radio]{padding:0}
|
|
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
|
textarea{overflow:auto;vertical-align:top}
|
|
table{border-collapse:collapse;border-spacing:0}
|
|
*,::before,::after{box-sizing:border-box}
|
|
html,body{font-size:100%}
|
|
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
|
a:hover{cursor:pointer}
|
|
img,object,embed{max-width:100%;height:auto}
|
|
object,embed{height:100%}
|
|
img{-ms-interpolation-mode:bicubic}
|
|
.left{float:left!important}
|
|
.right{float:right!important}
|
|
.text-left{text-align:left!important}
|
|
.text-right{text-align:right!important}
|
|
.text-center{text-align:center!important}
|
|
.text-justify{text-align:justify!important}
|
|
.hide{display:none}
|
|
img,object,svg{display:inline-block;vertical-align:middle}
|
|
textarea{height:auto;min-height:50px}
|
|
select{width:100%}
|
|
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
|
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
|
|
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
|
a:hover,a:focus{color:#1d4b8f}
|
|
a img{border:0}
|
|
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
|
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
|
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
|
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
|
h1{font-size:2.125em}
|
|
h2{font-size:1.6875em}
|
|
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
|
h4,h5{font-size:1.125em}
|
|
h6{font-size:1em}
|
|
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
|
|
em,i{font-style:italic;line-height:inherit}
|
|
strong,b{font-weight:bold;line-height:inherit}
|
|
small{font-size:60%;line-height:inherit}
|
|
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
|
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
|
ul,ol{margin-left:1.5em}
|
|
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
|
|
ul.circle{list-style-type:circle}
|
|
ul.disc{list-style-type:disc}
|
|
ul.square{list-style-type:square}
|
|
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
|
|
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
|
dl dt{margin-bottom:.3125em;font-weight:bold}
|
|
dl dd{margin-bottom:1.25em}
|
|
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
|
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
|
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
|
h1{font-size:2.75em}
|
|
h2{font-size:2.3125em}
|
|
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
|
h4{font-size:1.4375em}}
|
|
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
|
|
table thead,table tfoot{background:#f7f8f7}
|
|
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
|
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
|
table tr.even,table tr.alt{background:#f8f8f7}
|
|
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
|
|
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
|
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
|
.center{margin-left:auto;margin-right:auto}
|
|
.stretch{width:100%}
|
|
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
|
|
.clearfix::after,.float-group::after{clear:both}
|
|
:not(pre).nobreak{word-wrap:normal}
|
|
:not(pre).nowrap{white-space:nowrap}
|
|
:not(pre).pre-wrap{white-space:pre-wrap}
|
|
:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
|
|
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
|
|
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
|
|
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
|
|
em em{font-style:normal}
|
|
strong strong{font-weight:400}
|
|
.keyseq{color:rgba(51,51,51,.8)}
|
|
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
|
.keyseq kbd:first-child{margin-left:0}
|
|
.keyseq kbd:last-child{margin-right:0}
|
|
.menuseq,.menuref{color:#000}
|
|
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
|
.menuseq{word-spacing:-.02em}
|
|
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
|
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
|
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
|
|
b.button::before{content:"[";padding:0 3px 0 2px}
|
|
b.button::after{content:"]";padding:0 2px 0 3px}
|
|
p a>code:hover{color:rgba(0,0,0,.9)}
|
|
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
|
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
|
|
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
|
|
#content{margin-top:1.25em}
|
|
#content::before{content:none}
|
|
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
|
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
|
|
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
|
|
#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
|
|
#header .details span:first-child{margin-left:-.125em}
|
|
#header .details span.email a{color:rgba(0,0,0,.85)}
|
|
#header .details br{display:none}
|
|
#header .details br+span::before{content:"\00a0\2013\00a0"}
|
|
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
|
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
|
|
#header #revnumber{text-transform:capitalize}
|
|
#header #revnumber::after{content:"\00a0"}
|
|
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
|
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
|
|
#toc>ul{margin-left:.125em}
|
|
#toc ul.sectlevel0>li>a{font-style:italic}
|
|
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
|
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
|
#toc li{line-height:1.3334;margin-top:.3334em}
|
|
#toc a{text-decoration:none}
|
|
#toc a:active{text-decoration:underline}
|
|
#toctitle{color:#7a2518;font-size:1.2em}
|
|
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
|
|
body.toc2{padding-left:15em;padding-right:0}
|
|
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
|
|
#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
|
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
|
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
|
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
|
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
|
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
|
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
|
|
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
|
#toc.toc2{width:20em}
|
|
#toc.toc2 #toctitle{font-size:1.375em}
|
|
#toc.toc2>ul{font-size:.95em}
|
|
#toc.toc2 ul ul{padding-left:1.25em}
|
|
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
|
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
|
|
#content #toc>:first-child{margin-top:0}
|
|
#content #toc>:last-child{margin-bottom:0}
|
|
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
|
|
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
|
|
#content{margin-bottom:.625em}
|
|
.sect1{padding-bottom:.625em}
|
|
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
|
|
.sect1{padding-bottom:1.25em}}
|
|
.sect1:last-child{padding-bottom:0}
|
|
.sect1+.sect1{border-top:1px solid #e7e7e9}
|
|
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
|
#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
|
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
|
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
|
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
|
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
|
details{margin-left:1.25rem}
|
|
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
|
|
details>summary::-webkit-details-marker{display:none}
|
|
details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
|
|
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
|
|
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
|
|
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
|
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
|
|
.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
|
|
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
|
.admonitionblock>table td.icon{text-align:center;width:80px}
|
|
.admonitionblock>table td.icon img{max-width:none}
|
|
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
|
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
|
|
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
|
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
|
|
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
|
|
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
|
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
|
|
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
|
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
|
|
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
|
|
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
|
|
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
|
|
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
|
|
.listingblock>.content{position:relative}
|
|
.listingblock pre>code{display:block}
|
|
.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
|
|
.listingblock:hover code[data-lang]::before{display:block}
|
|
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
|
|
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
|
|
.listingblock pre.highlightjs{padding:0}
|
|
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
|
|
.listingblock pre.prettyprint{border-width:0}
|
|
.prettyprint{background:#f7f7f8}
|
|
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
|
|
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
|
|
pre.prettyprint li code[data-lang]::before{opacity:1}
|
|
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
|
|
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
|
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
|
|
table.linenotable td.code{padding-left:.75em}
|
|
table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
|
|
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
|
|
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
|
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
|
|
.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
|
.quoteblock blockquote{margin:0;padding:0;border:0}
|
|
.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
|
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
|
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
|
|
.verseblock{margin:0 1em 1.25em}
|
|
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
|
.verseblock pre strong{font-weight:400}
|
|
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
|
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
|
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
|
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
|
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
|
|
.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
|
|
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
|
|
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
|
|
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
|
|
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
|
|
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
|
|
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
|
|
p.tableblock:last-child{margin-bottom:0}
|
|
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
|
|
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
|
|
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
|
table.grid-all>*>tr>*{border-width:1px}
|
|
table.grid-cols>*>tr>*{border-width:0 1px}
|
|
table.grid-rows>*>tr>*{border-width:1px 0}
|
|
table.frame-all{border-width:1px}
|
|
table.frame-ends{border-width:1px 0}
|
|
table.frame-sides{border-width:0 1px}
|
|
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
|
|
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
|
|
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
|
|
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
|
|
table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
|
|
th.halign-left,td.halign-left{text-align:left}
|
|
th.halign-right,td.halign-right{text-align:right}
|
|
th.halign-center,td.halign-center{text-align:center}
|
|
th.valign-top,td.valign-top{vertical-align:top}
|
|
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
|
th.valign-middle,td.valign-middle{vertical-align:middle}
|
|
table thead th,table tfoot th{font-weight:bold}
|
|
tbody tr th{background:#f7f8f7}
|
|
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
|
p.tableblock>code:only-child{background:none;padding:0}
|
|
p.tableblock{font-size:1em}
|
|
ol{margin-left:1.75em}
|
|
ul li ol{margin-left:1.5em}
|
|
dl dd{margin-left:1.125em}
|
|
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
|
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
|
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
|
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
|
ul.unstyled,ol.unstyled{margin-left:0}
|
|
li>p:empty:only-child::before{content:"";display:inline-block}
|
|
ul.checklist>li>p:first-child{margin-left:-1em}
|
|
ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
|
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
|
|
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
|
|
ul.inline>li{margin-left:1.25em}
|
|
.unstyled dl dt{font-weight:400;font-style:normal}
|
|
ol.arabic{list-style-type:decimal}
|
|
ol.decimal{list-style-type:decimal-leading-zero}
|
|
ol.loweralpha{list-style-type:lower-alpha}
|
|
ol.upperalpha{list-style-type:upper-alpha}
|
|
ol.lowerroman{list-style-type:lower-roman}
|
|
ol.upperroman{list-style-type:upper-roman}
|
|
ol.lowergreek{list-style-type:lower-greek}
|
|
.hdlist>table,.colist>table{border:0;background:none}
|
|
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
|
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
|
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
|
td.hdlist2{word-wrap:anywhere}
|
|
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
|
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
|
|
.colist td:not([class]):first-child img{max-width:none}
|
|
.colist td:not([class]):last-child{padding:.25em 0}
|
|
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
|
|
.imageblock.left{margin:.25em .625em 1.25em 0}
|
|
.imageblock.right{margin:.25em 0 1.25em .625em}
|
|
.imageblock>.title{margin-bottom:0}
|
|
.imageblock.thumb,.imageblock.th{border-width:6px}
|
|
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
|
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
|
.image.left{margin-right:.625em}
|
|
.image.right{margin-left:.625em}
|
|
a.image{text-decoration:none;display:inline-block}
|
|
a.image object{pointer-events:none}
|
|
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
|
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
|
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
|
|
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
|
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
|
|
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
|
|
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
|
|
#footnotes .footnote:last-of-type{margin-bottom:0}
|
|
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
|
div.unbreakable{page-break-inside:avoid}
|
|
.big{font-size:larger}
|
|
.small{font-size:smaller}
|
|
.underline{text-decoration:underline}
|
|
.overline{text-decoration:overline}
|
|
.line-through{text-decoration:line-through}
|
|
.aqua{color:#00bfbf}
|
|
.aqua-background{background:#00fafa}
|
|
.black{color:#000}
|
|
.black-background{background:#000}
|
|
.blue{color:#0000bf}
|
|
.blue-background{background:#0000fa}
|
|
.fuchsia{color:#bf00bf}
|
|
.fuchsia-background{background:#fa00fa}
|
|
.gray{color:#606060}
|
|
.gray-background{background:#7d7d7d}
|
|
.green{color:#006000}
|
|
.green-background{background:#007d00}
|
|
.lime{color:#00bf00}
|
|
.lime-background{background:#00fa00}
|
|
.maroon{color:#600000}
|
|
.maroon-background{background:#7d0000}
|
|
.navy{color:#000060}
|
|
.navy-background{background:#00007d}
|
|
.olive{color:#606000}
|
|
.olive-background{background:#7d7d00}
|
|
.purple{color:#600060}
|
|
.purple-background{background:#7d007d}
|
|
.red{color:#bf0000}
|
|
.red-background{background:#fa0000}
|
|
.silver{color:#909090}
|
|
.silver-background{background:#bcbcbc}
|
|
.teal{color:#006060}
|
|
.teal-background{background:#007d7d}
|
|
.white{color:#bfbfbf}
|
|
.white-background{background:#fafafa}
|
|
.yellow{color:#bfbf00}
|
|
.yellow-background{background:#fafa00}
|
|
span.icon>.fa{cursor:default}
|
|
a span.icon>.fa{cursor:inherit}
|
|
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
|
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
|
|
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
|
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
|
|
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
|
|
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
|
|
.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
|
.conum[data-value] *{color:#fff!important}
|
|
.conum[data-value]+b{display:none}
|
|
.conum[data-value]::after{content:attr(data-value)}
|
|
pre .conum[data-value]{position:relative;top:-.125em}
|
|
b.conum *{color:inherit!important}
|
|
.conum:not([data-value]):empty{display:none}
|
|
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
|
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
|
|
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
|
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
|
|
p{margin-bottom:1.25rem}
|
|
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
|
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
|
.print-only{display:none!important}
|
|
@page{margin:1.25cm .75cm}
|
|
@media print{*{box-shadow:none!important;text-shadow:none!important}
|
|
html{font-size:80%}
|
|
a{color:inherit!important;text-decoration:underline!important}
|
|
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
|
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
|
abbr[title]{border-bottom:1px dotted}
|
|
abbr[title]::after{content:" (" attr(title) ")"}
|
|
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
|
thead{display:table-header-group}
|
|
svg{max-width:100%}
|
|
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
|
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
|
#header,#content,#footnotes,#footer{max-width:none}
|
|
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
|
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
|
|
body.book #header{text-align:center}
|
|
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
|
|
body.book #header .details{border:0!important;display:block;padding:0!important}
|
|
body.book #header .details span:first-child{margin-left:0!important}
|
|
body.book #header .details br{display:block}
|
|
body.book #header .details br+span::before{content:none!important}
|
|
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
|
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
|
.listingblock code[data-lang]::before{display:block}
|
|
#footer{padding:0 .9375em}
|
|
.hide-on-print{display:none!important}
|
|
.print-only{display:block!important}
|
|
.hide-for-print{display:none!important}
|
|
.show-for-print{display:inherit!important}}
|
|
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
|
|
.sect1{padding:0!important}
|
|
.sect1+.sect1{border:0}
|
|
#footer{background:none}
|
|
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
|
|
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
|
|
</style>
|
|
<style>
|
|
pre.rouge table td { padding: 5px; }
|
|
pre.rouge table pre { margin: 0; }
|
|
pre.rouge, pre.rouge .w {
|
|
color: #24292f;
|
|
background-color: #f6f8fa;
|
|
}
|
|
pre.rouge .k, pre.rouge .kd, pre.rouge .kn, pre.rouge .kp, pre.rouge .kr, pre.rouge .kt, pre.rouge .kv {
|
|
color: #cf222e;
|
|
}
|
|
pre.rouge .gr {
|
|
color: #f6f8fa;
|
|
}
|
|
pre.rouge .gd {
|
|
color: #82071e;
|
|
background-color: #ffebe9;
|
|
}
|
|
pre.rouge .nb {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .nc {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .no {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .nn {
|
|
color: #953800;
|
|
}
|
|
pre.rouge .sr {
|
|
color: #116329;
|
|
}
|
|
pre.rouge .na {
|
|
color: #116329;
|
|
}
|
|
pre.rouge .nt {
|
|
color: #116329;
|
|
}
|
|
pre.rouge .gi {
|
|
color: #116329;
|
|
background-color: #dafbe1;
|
|
}
|
|
pre.rouge .ges {
|
|
font-weight: bold;
|
|
font-style: italic;
|
|
}
|
|
pre.rouge .kc {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .l, pre.rouge .ld, pre.rouge .m, pre.rouge .mb, pre.rouge .mf, pre.rouge .mh, pre.rouge .mi, pre.rouge .il, pre.rouge .mo, pre.rouge .mx {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .sb {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .bp {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .ne {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .nl {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .py {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .nv, pre.rouge .vc, pre.rouge .vg, pre.rouge .vi, pre.rouge .vm {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .o, pre.rouge .ow {
|
|
color: #0550ae;
|
|
}
|
|
pre.rouge .gh {
|
|
color: #0550ae;
|
|
font-weight: bold;
|
|
}
|
|
pre.rouge .gu {
|
|
color: #0550ae;
|
|
font-weight: bold;
|
|
}
|
|
pre.rouge .s, pre.rouge .sa, pre.rouge .sc, pre.rouge .dl, pre.rouge .sd, pre.rouge .s2, pre.rouge .se, pre.rouge .sh, pre.rouge .sx, pre.rouge .s1, pre.rouge .ss {
|
|
color: #0a3069;
|
|
}
|
|
pre.rouge .nd {
|
|
color: #8250df;
|
|
}
|
|
pre.rouge .nf, pre.rouge .fm {
|
|
color: #8250df;
|
|
}
|
|
pre.rouge .err {
|
|
color: #f6f8fa;
|
|
background-color: #82071e;
|
|
}
|
|
pre.rouge .c, pre.rouge .ch, pre.rouge .cd, pre.rouge .cm, pre.rouge .cp, pre.rouge .cpf, pre.rouge .c1, pre.rouge .cs {
|
|
color: #6e7781;
|
|
}
|
|
pre.rouge .gl {
|
|
color: #6e7781;
|
|
}
|
|
pre.rouge .gt {
|
|
color: #6e7781;
|
|
}
|
|
pre.rouge .ni {
|
|
color: #24292f;
|
|
}
|
|
pre.rouge .si {
|
|
color: #24292f;
|
|
}
|
|
pre.rouge .ge {
|
|
color: #24292f;
|
|
font-style: italic;
|
|
}
|
|
pre.rouge .gs {
|
|
color: #24292f;
|
|
font-weight: bold;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="book toc2 toc-left">
|
|
<div id="header">
|
|
<h1>SprigX</h1>
|
|
<div class="details">
|
|
<span id="author" class="author">Brent Saner</span><br>
|
|
<span id="email" class="email"><a href="mailto:bts@square-r00t.net">bts@square-r00t.net</a></span><br>
|
|
<span id="revdate">Last rendered 2026-01-30 20:21:34 -0500</span>
|
|
</div>
|
|
<div id="toc" class="toc2">
|
|
<div id="toctitle">Table of Contents</div>
|
|
<ul class="sectlevel1">
|
|
<li><a href="#wat">1. What is SprigX?</a></li>
|
|
<li><a href="#use">2. How do I Use SprigX?</a></li>
|
|
<li><a href="#lib">3. Library Functions</a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#lib_cmbfmap">3.1. <code>CombinedFuncMap</code></a></li>
|
|
<li><a href="#lib_cmbhfmap">3.2. <code>CombinedHtmlFuncMap</code></a></li>
|
|
<li><a href="#lib_cmbtfmap">3.3. <code>CombinedTxtFuncMap</code></a></li>
|
|
<li><a href="#lib_fmap">3.4. <code>FuncMap</code></a></li>
|
|
<li><a href="#lib_hfmap">3.5. <code>HtmlFuncMap</code></a></li>
|
|
<li><a href="#lib_nop">3.6. <code>Nop</code></a></li>
|
|
<li><a href="#lib_tfmap">3.7. <code>TxtFuncMap</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn">4. Template Functions</a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#fn_dbg">4.1. Debugging</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_dbg_dump">4.1.1. <code>dump</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_meta">4.2. "Meta"/Template Helpers</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_meta_isnil">4.2.1. <code>metaIsNil</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_num">4.3. Numbers/Math</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_num_f32s">4.3.1. <code>numFloat32Str</code></a></li>
|
|
<li><a href="#fn_num_f64">4.3.2. <code>numFloat64</code></a></li>
|
|
<li><a href="#fn_num_f64s">4.3.3. <code>numFloat64Str</code></a></li>
|
|
<li><a href="#fn_num_fs">4.3.4. <code>numFloatStr</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_os">4.4. Operating System</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_os_fqdn">4.4.1. <code>osFQDN</code></a></li>
|
|
<li><a href="#fn_os_grpid">4.4.2. <code>osGroupById</code></a></li>
|
|
<li><a href="#fn_os_grpnm">4.4.3. <code>osGroupByName</code></a></li>
|
|
<li><a href="#fn_os_hst">4.4.4. <code>osHost</code></a></li>
|
|
<li><a href="#fn_os_hstnm">4.4.5. <code>osHostname</code></a></li>
|
|
<li><a href="#fn_os_idst">4.4.6. <code>osIdState</code></a></li>
|
|
<li><a href="#fn_os_usr">4.4.7. <code>osUser</code></a></li>
|
|
<li><a href="#fn_os_usrid">4.4.8. <code>osUserById</code></a></li>
|
|
<li><a href="#fn_os_usrnm">4.4.9. <code>osUserByName</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_path">4.5. Paths</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_path_gnrc">4.5.1. Generic</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_path_gnrc_pj">4.5.1.1. <code>pathJoin</code></a></li>
|
|
<li><a href="#fn_path_gnrc_ppj">4.5.1.2. <code>pathPipeJoin</code></a></li>
|
|
<li><a href="#fn_path_gnrc_psj">4.5.1.3. <code>pathSliceJoin</code></a></li>
|
|
<li><a href="#fn_path_gnrc_pspj">4.5.1.4. <code>pathSlicePipeJoin</code></a></li>
|
|
<li><a href="#fn_path_gnrc_psubj">4.5.1.5. <code>pathSubJoin</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_path_os">4.5.2. OS/Platform-Tailored</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_path_os_pj">4.5.2.1. <code>osPathJoin</code></a></li>
|
|
<li><a href="#fn_path_os_ppj">4.5.2.2. <code>osPathPipeJoin</code></a></li>
|
|
<li><a href="#fn_path_ossep">4.5.2.3. <code>osPathSep</code></a></li>
|
|
<li><a href="#fn_path_os_psj">4.5.2.4. <code>osPathSliceJoin</code></a></li>
|
|
<li><a href="#fn_path_os_pspj">4.5.2.5. <code>osPathSlicePipeJoin</code></a></li>
|
|
<li><a href="#fn_path_os_psubj">4.5.2.6. <code>osPathSubJoin</code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps">4.6. PSUtil</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_ps_cpu">4.6.1. CPU/Processor</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_cpu_cnts">4.6.1.1. <code>psCpuCnts</code></a></li>
|
|
<li><a href="#fn_ps_cpu_info">4.6.1.2. <code>psCpuInfo</code></a></li>
|
|
<li><a href="#fn_ps_cpu_pct">4.6.1.3. <code>psCpuPct</code></a></li>
|
|
<li><a href="#fn_ps_cpu_tms">4.6.1.4. <code>psCpuTimes</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_dsk">4.6.2. Disk</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_dsk_iocnts">4.6.2.1. <code>psDiskIoCnts</code></a></li>
|
|
<li><a href="#fn_ps_dsk_lbl">4.6.2.2. <code>psDiskLabel</code></a></li>
|
|
<li><a href="#fn_ps_dsk_parts">4.6.2.3. <code>psDiskParts</code></a></li>
|
|
<li><a href="#fn_ps_dsk_srl">4.6.2.4. <code>psDiskSerial</code></a></li>
|
|
<li><a href="#fn_ps_dsk_usg">4.6.2.5. <code>psDiskUsage</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_hst">4.6.3. Host</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_hst_boot">4.6.3.1. <code>psHostBoot</code></a></li>
|
|
<li><a href="#fn_ps_hst_id">4.6.3.2. <code>psHostId</code></a></li>
|
|
<li><a href="#fn_ps_hst_info">4.6.3.3. <code>psHostInfo</code></a></li>
|
|
<li><a href="#fn_ps_hst_krnarch">4.6.3.4. <code>psHostKernArch</code></a></li>
|
|
<li><a href="#fn_ps_hst_krnver">4.6.3.5. <code>psHostKernVer</code></a></li>
|
|
<li><a href="#fn_ps_hst_plat">4.6.3.6. <code>psHostPlatInfo</code></a></li>
|
|
<li><a href="#fn_ps_hst_uptm">4.6.3.7. <code>psHostPlatUptime</code></a></li>
|
|
<li><a href="#fn_ps_hst_usrs">4.6.3.8. <code>psHostUsers</code></a></li>
|
|
<li><a href="#fn_ps_hst_virt">4.6.3.9. <code>psHostPlatVirt</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_ld">4.6.4. Load</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_ld_avg">4.6.4.1. <code>psLoadAvg</code></a></li>
|
|
<li><a href="#fn_ps_ld_misc">4.6.4.2. <code>psLoadMisc</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_mem">4.6.5. Memory</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_mem_exvmem">4.6.5.1. <code>psMemExVMem</code></a></li>
|
|
<li><a href="#fn_ps_mem_swap">4.6.5.2. <code>psMemSwap</code></a></li>
|
|
<li><a href="#fn_ps_mem_swapdevs">4.6.5.3. <code>psMemSwapDevs</code></a></li>
|
|
<li><a href="#fn_ps_mem_vmem">4.6.5.4. <code>psMemVMem</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_net">4.6.6. Network</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_net_conns">4.6.6.1. <code>psNetConns</code></a></li>
|
|
<li><a href="#fn_ps_net_connsmax">4.6.6.2. <code>psNetConnsMax</code></a></li>
|
|
<li><a href="#fn_ps_net_connspid">4.6.6.3. <code>psNetConnsPid</code></a></li>
|
|
<li><a href="#fn_ps_net_connspidmax">4.6.6.4. <code>psNetConnsPidMax</code></a></li>
|
|
<li><a href="#fn_ps_net_ct">4.6.6.5. <code>psNetCTStats</code></a></li>
|
|
<li><a href="#fn_ps_net_ctlist">4.6.6.6. <code>psNetCTStatList</code></a></li>
|
|
<li><a href="#fn_ps_net_fltcnt">4.6.6.7. <code>psNetFilterCnts</code></a></li>
|
|
<li><a href="#fn_ps_net_iocnts">4.6.6.8. <code>psNetIoCnts</code></a></li>
|
|
<li><a href="#fn_ps_net_iocntsfl">4.6.6.9. <code>psNetIoCntsFile</code></a></li>
|
|
<li><a href="#fn_ps_net_ifaces">4.6.6.10. <code>psNetIfaces</code></a></li>
|
|
<li><a href="#fn_ps_net_pids">4.6.6.11. <code>psNetPids</code></a></li>
|
|
<li><a href="#fn_ps_net_protocnts">4.6.6.12. <code>psNetProtoCnt</code></a></li>
|
|
<li><a href="#fn_ps_net_rev">4.6.6.13. <code>psNetRev</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_proc">4.6.7. Processes</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_procs_procs">4.6.7.1. <code>psProcs</code></a></li>
|
|
<li><a href="#fn_ps_proc_new">4.6.7.2. <code>psProcNew</code></a></li>
|
|
<li><a href="#fn_ps_proc_pids">4.6.7.3. <code>psProcPids</code></a></li>
|
|
<li><a href="#fn_ps_proc_pidxst">4.6.7.4. <code>psProcPidExists</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_sns">4.6.8. Sensors/Thermals</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_sns_extemp">4.6.8.1. <code>psSensorExTemp</code></a></li>
|
|
<li><a href="#fn_ps_sns_temps">4.6.8.2. <code>psSensorTemps</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_ps_winsvc">4.6.9. Windows Services</a>
|
|
<ul class="sectlevel4">
|
|
<li><a href="#fn_ps_winsvc_list">4.6.9.1. <code>psWinsvcList</code></a></li>
|
|
<li><a href="#fn_ps_winsvc_new">4.6.9.2. <code>psWinsvcNew</code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_str">4.7. Strings</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_str_extindent">4.7.1. <code>extIndent</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_tm">4.8. Time/Dates/Timestamps</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_tm_date">4.8.1. <code>tmDate</code></a></li>
|
|
<li><a href="#fn_tm_fltmic">4.8.2. <code>tmFloatMicro</code></a></li>
|
|
<li><a href="#fn_tm_fltmill">4.8.3. <code>tmFloatMilli</code></a></li>
|
|
<li><a href="#fn_tm_fltnano">4.8.4. <code>tmFloatNano</code></a></li>
|
|
<li><a href="#fn_tm_flt">4.8.5. <code>tmFloat</code></a></li>
|
|
<li><a href="#fn_tm_fmt">4.8.6. <code>tmFmt</code></a></li>
|
|
<li><a href="#fn_tm_now">4.8.7. <code>tmNow</code></a></li>
|
|
<li><a href="#fn_tm_pdur8n">4.8.8. <code>tmParseDur8n</code></a></li>
|
|
<li><a href="#fn_tm_pmnth">4.8.9. <code>tmParseMonth</code></a></li>
|
|
<li><a href="#fn_tm_pmnthi">4.8.10. <code>tmParseMonthInt</code></a></li>
|
|
<li><a href="#fn_tm_pmnths">4.8.11. <code>tmParseMonthStr</code></a></li>
|
|
<li><a href="#fn_tm_ptm">4.8.12. <code>tmParseTime</code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#fn_sys">4.9. System/Platform/Architecture</a>
|
|
<ul class="sectlevel3">
|
|
<li><a href="#fn_sys_arch">4.9.1. <code>sysArch</code></a></li>
|
|
<li><a href="#fn_sys_numcpu">4.9.2. <code>sysNumCpu</code></a></li>
|
|
<li><a href="#fn_sys_os">4.9.3. <code>sysOsName</code></a></li>
|
|
<li><a href="#fn_sys_rntm">4.9.4. <code>sysRuntime</code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="wat"><a class="link" href="#wat">1. What is SprigX?</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>SprigX is a suite of extensions to <a href="https://masterminds.github.io/sprig/" target="_blank" rel="noopener">the <code>sprig</code> library</a> (<a href="https://pkg.go.dev/github.com/Masterminds/sprig/v3" target="_blank" rel="noopener">Go docs</a>).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>They provide functions that offer more enriched use cases and domain-specific data.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>If you are reading this README on the Go Module Directory documentation (<a href="https://pkg.go.dev/r00t2.io/goutils/tplx/sprigx" class="bare">https://pkg.go.dev/r00t2.io/goutils/tplx/sprigx</a>)
|
|
or the directory landing page (<a href="https://git.r00t2.io/r00t2/go_goutils/src/branch/master/tplx/sprigx" class="bare">https://git.r00t2.io/r00t2/go_goutils/src/branch/master/tplx/sprigx</a>), it may not render correctly.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Be sure to view it at properly via <a href="https://git.r00t2.io/r00t2/go_goutils/src/branch/master/tplx/sprigx/README.adoc" target="_blank" rel="noopener">the AsciiDoc rendering</a>
|
|
or by downloading and viewing the <a href="https://git.r00t2.io/r00t2/go_goutils/raw/branch/master/tplx/sprigx/README.html" target="_blank" rel="noopener">HTML version</a>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="use"><a class="link" href="#use">2. How do I Use SprigX?</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>The same way you would <code>sprig</code>!</p>
|
|
</div>
|
|
<details>
|
|
<summary class="title">Like this.</summary>
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">package</span> <span class="n">main</span>
|
|
|
|
<span class="k">import</span> <span class="p">(</span>
|
|
<span class="n">htmlTplLib</span> <span class="s">"html/template"</span>
|
|
<span class="n">txtTplLib</span> <span class="s">"text/template"</span>
|
|
|
|
<span class="s">"r00t2.io/goutils/tplx/sprigx"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">var</span> <span class="p">(</span>
|
|
<span class="n">txtTpl</span> <span class="o">*</span><span class="n">txtTplLib</span><span class="o">.</span><span class="n">Template</span> <span class="o">=</span> <span class="n">txtTplLib</span><span class="o">.</span>
|
|
<span class="n">New</span><span class="p">(</span><span class="s">""</span><span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span>
|
|
<span class="n">sprigx</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">(),</span>
|
|
<span class="p">)</span>
|
|
<span class="n">htmlTpl</span> <span class="o">*</span><span class="n">htmlTplLib</span><span class="o">.</span><span class="n">Template</span> <span class="o">=</span> <span class="n">htmlTplLib</span><span class="o">.</span>
|
|
<span class="n">New</span><span class="p">(</span><span class="s">""</span><span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span>
|
|
<span class="n">sprigx</span><span class="o">.</span><span class="n">HtmlFuncMap</span><span class="p">(),</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</details>
|
|
<div class="paragraph">
|
|
<p>They can even be combined/used together.</p>
|
|
</div>
|
|
<details>
|
|
<summary class="title">Like this.</summary>
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">package</span> <span class="n">main</span>
|
|
|
|
<span class="k">import</span> <span class="p">(</span>
|
|
<span class="s">"text/template"</span>
|
|
|
|
<span class="s">"github.com/Masterminds/sprig/v3"</span>
|
|
<span class="s">"r00t2.io/goutils/tplx/sprigx"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">var</span> <span class="n">txtTpl</span> <span class="o">*</span><span class="n">template</span><span class="o">.</span><span class="n">Template</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span>
|
|
<span class="n">New</span><span class="p">(</span><span class="s">""</span><span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span>
|
|
<span class="n">sprigx</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">(),</span>
|
|
<span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span>
|
|
<span class="n">sprig</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">(),</span>
|
|
<span class="p">)</span>
|
|
<span class="c">// Or:</span>
|
|
<span class="c">/*
|
|
var txtTpl *template.Template = template.
|
|
New("").
|
|
Funcs(
|
|
sprig.TxtFuncMap(),
|
|
).
|
|
Funcs(
|
|
sprigx.TxtFuncMap(),
|
|
)
|
|
*/</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</details>
|
|
<div class="paragraph">
|
|
<p>Or, as a convenience, you can simply use the <a href="#lib_cmbtfmap"><code>sprigx.CombinedTxtFuncMap</code></a> and/or <a href="#lib_cmbhfmap"><code>sprigx.CombinedHtmlFuncMap</code></a> functions.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>If a <code><template>.FuncMap</code> is added via <code>.Funcs()</code> <strong>after</strong> template parsing, it will override any functions of the same name of a <code><template>.FuncMap</code> <strong>before</strong> parsing.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>For example, if both <code>sprig</code> and <code>sprigx</code> provide a function <code>foo</code>:</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>this will use <code>foo</code> from <code>sprigx</code></p>
|
|
</div>
|
|
<details>
|
|
<summary class="title">(show)</summary>
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">package</span> <span class="n">main</span>
|
|
|
|
<span class="k">import</span> <span class="p">(</span>
|
|
<span class="s">"text/template"</span>
|
|
|
|
<span class="s">"github.com/Masterminds/sprig/v3"</span>
|
|
<span class="s">"r00t2.io/goutils/tplx/sprigx"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">const</span> <span class="p">(</span>
|
|
<span class="n">myTpl</span> <span class="kt">string</span> <span class="o">=</span> <span class="s">`{{ "This is an example template string." | foo }}`</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">var</span> <span class="p">(</span>
|
|
<span class="n">tpl</span> <span class="o">*</span><span class="n">template</span><span class="o">.</span><span class="n">Template</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">Must</span><span class="p">(</span>
|
|
<span class="n">template</span><span class="o">.</span>
|
|
<span class="n">New</span><span class="p">(</span><span class="s">""</span><span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span><span class="n">sprig</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">())</span><span class="o">.</span>
|
|
<span class="n">Parse</span><span class="p">(</span><span class="n">myTpl</span><span class="p">),</span>
|
|
<span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span><span class="n">sprigx</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">())</span>
|
|
<span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</details>
|
|
<div class="paragraph">
|
|
<p>whereas this will use <code>foo</code> from <code>sprig</code></p>
|
|
</div>
|
|
<details>
|
|
<summary class="title">(show)</summary>
|
|
<div class="content">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">package</span> <span class="n">main</span>
|
|
|
|
<span class="k">import</span> <span class="p">(</span>
|
|
<span class="s">"text/template"</span>
|
|
|
|
<span class="s">"github.com/Masterminds/sprig/v3"</span>
|
|
<span class="s">"r00t2.io/goutils/tplx/sprigx"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">const</span> <span class="p">(</span>
|
|
<span class="n">myTpl</span> <span class="kt">string</span> <span class="o">=</span> <span class="s">`{{ "This is an example template string." | foo }}`</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">var</span> <span class="p">(</span>
|
|
<span class="n">tpl</span> <span class="o">*</span><span class="n">template</span><span class="o">.</span><span class="n">Template</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">Must</span><span class="p">(</span>
|
|
<span class="n">template</span><span class="o">.</span>
|
|
<span class="n">New</span><span class="p">(</span><span class="s">""</span><span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span><span class="n">sprigx</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">())</span><span class="o">.</span>
|
|
<span class="n">Parse</span><span class="p">(</span><span class="n">myTpl</span><span class="p">),</span>
|
|
<span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span><span class="n">sprig</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">())</span>
|
|
<span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</details>
|
|
<div class="paragraph">
|
|
<p>and a function can even be explicitly <a id="override"></a>overridden.</p>
|
|
</div>
|
|
<details>
|
|
<summary class="title">(show)</summary>
|
|
<div class="content">
|
|
<div class="paragraph">
|
|
<p>This would override a function <code>foo</code> and <code>foo2</code> in <code>sprigx</code> from <code>foo</code> and <code>foo2</code> from <code>sprig</code>, but leave all other <code>sprig</code> functions untouched.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">package</span> <span class="n">main</span>
|
|
|
|
<span class="k">import</span> <span class="p">(</span>
|
|
<span class="s">"text/template"</span>
|
|
|
|
<span class="s">"github.com/Masterminds/sprig/v3"</span>
|
|
<span class="s">"r00t2.io/goutils/tplx/sprigx"</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">const</span> <span class="p">(</span>
|
|
<span class="n">myTpl</span> <span class="kt">string</span> <span class="o">=</span> <span class="s">`{{ "This is an example template string." | foo }}`</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">var</span> <span class="p">(</span>
|
|
<span class="n">overrideFuncs</span> <span class="n">template</span><span class="o">.</span><span class="n">FuncMap</span> <span class="o">=</span> <span class="n">sprig</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">()</span>
|
|
<span class="n">tpl</span> <span class="o">*</span><span class="n">template</span><span class="o">.</span><span class="n">Template</span> <span class="o">=</span> <span class="n">template</span><span class="o">.</span><span class="n">Must</span><span class="p">(</span>
|
|
<span class="n">template</span><span class="o">.</span>
|
|
<span class="n">New</span><span class="p">(</span><span class="s">""</span><span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span><span class="n">sprigx</span><span class="o">.</span><span class="n">TxtFuncMap</span><span class="p">())</span><span class="o">.</span>
|
|
<span class="n">Parse</span><span class="p">(</span><span class="n">myTpl</span><span class="p">),</span>
|
|
<span class="p">)</span><span class="o">.</span>
|
|
<span class="n">Funcs</span><span class="p">(</span>
|
|
<span class="n">template</span><span class="o">.</span><span class="n">FuncMap</span><span class="p">(</span>
|
|
<span class="k">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="n">any</span><span class="p">{</span>
|
|
<span class="s">"foo"</span><span class="o">:</span> <span class="n">overrideFuncs</span><span class="p">[</span><span class="s">"foo"</span><span class="p">],</span>
|
|
<span class="s">"foo2"</span><span class="o">:</span> <span class="n">overrideFuncs</span><span class="p">[</span><span class="s">"foo2"</span><span class="p">],</span>
|
|
<span class="p">},</span>
|
|
<span class="p">),</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="lib"><a class="link" href="#lib">3. Library Functions</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>These are generally intended to be used <strong>outside</strong> the template in the actual Go code.</p>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_cmbfmap"><a class="link" href="#lib_cmbfmap">3.1. <code>CombinedFuncMap</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">CombinedFuncMap</span><span class="p">(</span><span class="n">preferSprigX</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">fmap</span> <span class="k">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="n">any</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns a generic function map (like <a href="#lib_fmap"><code>FuncMap</code></a>) combined with
|
|
<a href="https://pkg.go.dev/github.com/Masterminds/sprig/v3#GenericFuncMap" target="_blank" rel="noopener"><code>github.com/Masterminds/sprig/v3.GenericFuncMap</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>If <code>preferSprigx</code> is true, SprigX function names will override Sprig functions with the same name.
|
|
If false, Sprig functions will override conflicting SprigX functions with the same name.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>You probably want <a href="#lib_cmbtfmap"><code>CombinedTxtFuncMap</code></a> or <a href="#lib_cmbhfmap"><code>CombinedHtmlFuncMap</code></a> instead,
|
|
as they wrap this with the appropriate type.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_cmbhfmap"><a class="link" href="#lib_cmbhfmap">3.2. <code>CombinedHtmlFuncMap</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">CombinedHtmlFuncMap</span><span class="p">(</span><span class="n">preferSprigX</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">fmap</span> <span class="p">(</span><span class="n">html</span><span class="o">/</span><span class="n">template</span><span class="p">)</span><span class="o">.</span><span class="n">FuncMap</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns an <a href="https://pkg.go.dev/html/template#FuncMap"><code>(html/template).FuncMap</code></a> function map (like <a href="#lib_hfmap"><code>HtmlFuncMap</code></a>) combined with
|
|
<a href="https://pkg.go.dev/github.com/Masterminds/sprig/v3#HtmlFuncMap" target="_blank" rel="noopener"><code>github.com/Masterminds/sprig/v3.HtmlFuncMap</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>If <code>preferSprigx</code> is true, SprigX function names will override Sprig functions with the same name.
|
|
If false, Sprig functions will override conflicting SprigX functions with the same name.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_cmbtfmap"><a class="link" href="#lib_cmbtfmap">3.3. <code>CombinedTxtFuncMap</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">CombinedTxtFuncMap</span><span class="p">(</span><span class="n">preferSprigX</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">fmap</span> <span class="p">(</span><span class="n">text</span><span class="o">/</span><span class="n">template</span><span class="p">)</span><span class="o">.</span><span class="n">FuncMap</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns a <a href="https://pkg.go.dev/text/template#FuncMap"><code>(text/template).FuncMap</code></a> function map (like <a href="#lib_tfmap"><code>TxtFuncMap</code></a>) combined with
|
|
<a href="https://pkg.go.dev/github.com/Masterminds/sprig/v3#TxtFuncMap" target="_blank" rel="noopener"><code>github.com/Masterminds/sprig/v3.TxtFuncMap</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>If <code>preferSprigx</code> is true, SprigX function names will override Sprig functions with the same name.
|
|
If false, Sprig functions will override conflicting SprigX functions with the same name.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_fmap"><a class="link" href="#lib_fmap">3.4. <code>FuncMap</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">FuncMap</span><span class="p">()</span> <span class="p">(</span><span class="n">fmap</span> <span class="k">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="n">any</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns a generic SprigX function map.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>You probably want <a href="#lib_tfmap"><code>TxtFuncMap</code></a> or <a href="#lib_hfmap"><code>HtmlFuncMap</code></a> instead,
|
|
as they wrap this with the appropriate type.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_hfmap"><a class="link" href="#lib_hfmap">3.5. <code>HtmlFuncMap</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">HtmlFuncMap</span><span class="p">()</span> <span class="p">(</span><span class="n">fmap</span> <span class="p">(</span><span class="n">html</span><span class="o">/</span><span class="n">template</span><span class="p">)</span><span class="o">.</span><span class="n">FuncMap</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns a SprigX <a href="https://pkg.go.dev/html/template#FuncMap" target="_blank" rel="noopener"><code>(html/template).FuncMap</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_nop"><a class="link" href="#lib_nop">3.6. <code>Nop</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">Nop</span><span class="p">(</span><span class="n">obj</span> <span class="o">...</span><span class="n">any</span><span class="p">)</span> <span class="p">(</span><span class="n">s</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>Nop</code> is a NO-OP function that one can use in an <a href="#override">override map</a> to explicitly disable
|
|
certain Sprig/SprigX functions that may be deemed "unsafe" and/or to sanitize templates from untrusted input.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It will <strong>never</strong> error or panic, and <code>s</code> is <strong>always</strong> an empty string.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="lib_tfmap"><a class="link" href="#lib_tfmap">3.7. <code>TxtFuncMap</code></a></h3>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">TxtFuncMap</span><span class="p">()</span> <span class="p">(</span><span class="n">fmap</span> <span class="p">(</span><span class="n">text</span><span class="o">/</span><span class="n">template</span><span class="p">)</span><span class="o">.</span><span class="n">FuncMap</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns a SprigX <a href="https://pkg.go.dev/text/template#FuncMap" target="_blank" rel="noopener"><code>(text/template).FuncMap</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="fn"><a class="link" href="#fn">4. Template Functions</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>Expect this list to grow over time, and potentially more frequently than the <code>sprigx</code> functions.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Each function includes its function signature to indicate what types of arguments/parameters it accepts,
|
|
what it returns, and if it may potentially return an error or not.</p>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_dbg"><a class="link" href="#fn_dbg">4.1. Debugging</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_dbg_dump"><a class="link" href="#fn_dbg_dump">4.1.1. <code>dump</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">dump</span><span class="p">(</span><span class="n">a</span> <span class="o">...</span><span class="k">interface</span><span class="p">{})</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The <code>dump</code> function directly calls <a href="https://pkg.go.dev/github.com/davecgh/go-spew/spew#Sdump" target="_blank" rel="noopener"><code>github.com/davecgh/go-spew/spew.Sdump</code></a>
|
|
for whatever object(s) is/are passed to it.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_meta"><a class="link" href="#fn_meta">4.2. "Meta"/Template Helpers</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_meta_isnil"><a class="link" href="#fn_meta_isnil">4.2.1. <code>metaIsNil</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">metaIsNil</span><span class="p">(</span><span class="n">obj</span> <span class="n">any</span><span class="p">)</span> <span class="p">(</span><span class="n">isNil</span> <span class="kt">bool</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>metaIsNil</code> returns <code>true</code> if <code>obj</code> is explicitly nil, otherwise it returns false.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function fills in the gap that <a href="https://pkg.go.dev/text/template#IsTrue" target="_blank" rel="noopener"><code>text/template.IsTrue</code></a> and <a href="https://pkg.go.dev/html/template#IsTrue" target="_blank" rel="noopener"><code>html/template.IsTrue</code></a> (expressed in templates as <code>{{ if …​ }}</code>) leaves, as those functions/expressions return false for e.g. <code>false</code> booleans AND nils.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_num"><a class="link" href="#fn_num">4.3. Numbers/Math</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_num_f32s"><a class="link" href="#fn_num_f32s">4.3.1. <code>numFloat32Str</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">numFloat32Str</span><span class="p">(</span><span class="n">f</span> <span class="kt">float32</span><span class="p">)</span> <span class="p">(</span><span class="n">s</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>numFloat32Str</code> returns a <strong>complete</strong> non-truncated non-right-padded string representation of a <code>float32</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_num_f64"><a class="link" href="#fn_num_f64">4.3.2. <code>numFloat64</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">numFloat64</span><span class="p">(</span><span class="n">val</span> <span class="n">any</span><span class="p">)</span> <span class="p">(</span><span class="n">f</span> <span class="kt">float64</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>numFloat64</code> returns any string representation of a numeric value or any type of numeric value to a <code>float64</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_num_f64s"><a class="link" href="#fn_num_f64s">4.3.3. <code>numFloat64Str</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">numFloat64Str</span><span class="p">(</span><span class="n">f</span> <span class="kt">float64</span><span class="p">)</span> <span class="p">(</span><span class="n">s</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>numFloat64Str</code> returns a <strong>complete</strong> non-truncated non-right-padded string representation of a <code>float64</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_num_fs"><a class="link" href="#fn_num_fs">4.3.4. <code>numFloatStr</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">numFloatStr</span><span class="p">(</span><span class="n">val</span> <span class="n">any</span><span class="p">)</span> <span class="p">(</span><span class="n">s</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>numFloatStr</code> wraps <a href="#fn_num_f32s"><code>numFloat32Str</code></a> and <a href="#fn_num_f64s"><code>numFloat64Str</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>val</code> can be a string representation of any numeric value or any type of numeric value.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_os"><a class="link" href="#fn_os">4.4. Operating System</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_fqdn"><a class="link" href="#fn_os_fqdn">4.4.1. <code>osFQDN</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osFQDN</span><span class="p">()</span> <span class="p">(</span><span class="n">fqdn</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osFQDN</code> currently just directly calls <a href="https://pkg.go.dev/os#Hostname" target="_blank" rel="noopener"><code>os.Hostname</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>As such, it comes with the same caveats — namely that it isn’t guaranteed to be
|
|
an FQDN, it will be precisely/exactly whatever the kernel/OS hostname is set as.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>In the future, it may be extended to support a more diligent effort to determine
|
|
an actual FQDN, and return an error if it is unable to be derived.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>To (relatively) predictably get the "short hostname", use <a href="#fn_os_hst"><code>osHost</code></a>.
|
|
To directly/predictably use <a href="https://pkg.go.dev/os#Hostname" target="_blank" rel="noopener"><code>os.Hostname</code></a>, use <a href="#fn_os_hstnm"><code>osHostname</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_grpid"><a class="link" href="#fn_os_grpid">4.4.2. <code>osGroupById</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osGroupById</span><span class="p">[</span><span class="n">T</span> <span class="kt">string</span> <span class="o">|</span> <span class="kt">int</span><span class="p">](</span><span class="n">gid</span> <span class="n">T</span><span class="p">)</span> <span class="p">(</span><span class="n">g</span> <span class="o">*</span><span class="n">user</span><span class="o">.</span><span class="n">Group</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osGroupById</code> returns an <a href="https://pkg.go.dev/os/user#Group" target="_blank" rel="noopener"><code>os/user.Group</code></a> from a given group ID/GID.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It more or less behaves exactly like <a href="https://pkg.go.dev/os/user#LookupGroupId" target="_blank" rel="noopener"><code>os/user.LookupGroupId</code></a>,
|
|
except it will accept either a <code>string</code> <strong>or</strong> an <code>int</code> as the GID.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_grpnm"><a class="link" href="#fn_os_grpnm">4.4.3. <code>osGroupByName</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osGroupByName</span><span class="p">(</span><span class="n">grpNm</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">g</span> <span class="o">*</span><span class="n">user</span><span class="o">.</span><span class="n">Group</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osGroupByName</code> returns an <a href="https://pkg.go.dev/os/user#Group" target="_blank" rel="noopener"><code>os/user.Group</code></a> from a given group name.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It behaves exactly like <a href="https://pkg.go.dev/os/user#LookupGroup" target="_blank" rel="noopener"><code>os/user.LookupGroup</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_hst"><a class="link" href="#fn_os_hst">4.4.4. <code>osHost</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osHost</span><span class="p">()</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osHost</code> returns the "short hostname" by calling <a href="https://pkg.go.dev/os#Hostname" target="_blank" rel="noopener"><code>os.Hostname</code></a>
|
|
and returning the first "host label" (as RFCs refer to it).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>e.g.:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $fqdn := osFQDN -}}
|
|
{{- $h := osHost -}}
|
|
{{- $cmp := index ($fqdn | splitList ".") 0 -}}
|
|
osHost {{ $h }} should be equal to first label of FQDN {{ $cmp }}.</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>The <code>splitList</code> function shown aboce is from the <a href="https://masterminds.github.io/sprig/string_slice.html" target="_blank" rel="noopener"><code>sprig</code> string slice functions</a>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>To (try to) get the FQDN, use <a href="#fn_os_fqdn"><code>osFQDN</code></a>.
|
|
To directly use <a href="https://pkg.go.dev/os#Hostname" target="_blank" rel="noopener"><code>os.Hostname</code></a>, use <a href="#fn_os_hstnm"><code>osHostname</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_hstnm"><a class="link" href="#fn_os_hstnm">4.4.5. <code>osHostname</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osHostname</span><span class="p">()</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osHostname</code> directly calls <a href="https://pkg.go.dev/os#Hostname" target="_blank" rel="noopener"><code>os.Hostname</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_idst"><a class="link" href="#fn_os_idst">4.4.6. <code>osIdState</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osIdState</span><span class="p">()</span> <span class="p">(</span><span class="n">idst</span> <span class="n">sysutils</span><span class="o">.</span><span class="n">IDState</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osIdState</code> returns the current runtime process' <a href="https://pkg.go.dev/r00t2.io/sysutils#IDState" target="_blank" rel="noopener"><code>r00t2.io/sysutils.IDState</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It directly calls <a href="https://pkg.go.dev/r00t2.io/sysutils#GetIDState" target="_blank" rel="noopener"><code>r00t2.io/sysutils.GetIDState</code></a>.</p>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This is more or less useless on Windows; it returns only a dummy struct for cross-platform compatibility.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_usr"><a class="link" href="#fn_os_usr">4.4.7. <code>osUser</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osUser</span><span class="p">()</span> <span class="p">(</span><span class="n">u</span> <span class="o">*</span><span class="n">user</span><span class="o">.</span><span class="n">User</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osUser</code> returns the current runtime process' <a href="https://pkg.go.dev/os/user#User" target="_blank" rel="noopener"><code>os/user.User</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It directly calls <a href="https://pkg.go.dev/os/user#Current" target="_blank" rel="noopener"><code>os/user.Current</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_usrid"><a class="link" href="#fn_os_usrid">4.4.8. <code>osUserById</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osUserById</span><span class="p">[</span><span class="n">T</span> <span class="kt">string</span> <span class="o">|</span> <span class="kt">int</span><span class="p">](</span><span class="n">uid</span> <span class="n">T</span><span class="p">)</span> <span class="p">(</span><span class="n">u</span> <span class="o">*</span><span class="n">user</span><span class="o">.</span><span class="n">User</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osUserById</code> returns an <a href="https://pkg.go.dev/os/user#User" target="_blank" rel="noopener"><code>os/user.User</code></a> from a given user ID/UID.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It more or less behaves exactly like <a href="https://pkg.go.dev/os/user#LookupId" target="_blank" rel="noopener"><code>os/user.LookupId</code></a>,
|
|
except it will accept either a <code>string</code> <strong>or</strong> an <code>int</code> as the UID.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_os_usrnm"><a class="link" href="#fn_os_usrnm">4.4.9. <code>osUserByName</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osUserByName</span><span class="p">(</span><span class="n">userNm</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">u</span> <span class="o">*</span><span class="n">user</span><span class="o">.</span><span class="n">User</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osUserByName</code> returns an <a href="https://pkg.go.dev/os/user#User" target="_blank" rel="noopener"><code>os/user.User</code></a> from a given username.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It directly calls <a href="https://pkg.go.dev/os/user#Lookup" target="_blank" rel="noopener"><code>os/user.Lookup</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_path"><a class="link" href="#fn_path">4.5. Paths</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_path_gnrc"><a class="link" href="#fn_path_gnrc">4.5.1. Generic</a></h4>
|
|
<div class="paragraph">
|
|
<p>These operate similar to <a href="https://pkg.go.dev/path" target="_blank" rel="noopener">the <code>path</code> stdlib library</a> and use a fixed <code>/</code> path separator.</p>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_gnrc_pj"><a class="link" href="#fn_path_gnrc_pj">4.5.1.1. <code>pathJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">pathJoin</span><span class="p">(</span><span class="n">elem</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>pathJoin</code> directly calls <a href="https://pkg.go.dev/path#Join" target="_blank" rel="noopener"><code>path.Join</code></a>.</p>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>If you are joining paths in a pipeline, you almost assuredly want <a href="#fn_path_gnrc_ppj"><code>pathPipeJoin</code></a> or <a href="#fn_path_gnrc_pspj"><code>pathSlicePipeJoin</code></a> instead
|
|
unless you are explicitly <strong>appending</strong> a pipeline result to a path.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- pathJoin "a" "b" "c" }}
|
|
{{- pathJoin "/" "a" "b" "c" }}
|
|
{{- pathJoin "/a/b" "c" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a/b/c
|
|
/a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_gnrc_ppj"><a class="link" href="#fn_path_gnrc_ppj">4.5.1.2. <code>pathPipeJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">pathPipeJoin</span><span class="p">(</span><span class="n">elems</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>pathPipeJoin</code> operates like <a href="#fn_path_gnrc_pj"><code>pathJoin</code></a> with one deviation: the root/base path is expected to be <strong>last</strong> in the arguments.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This makes it much more suitable for use in template pipelines, as the previous value in a pipeline is passed in
|
|
as the last element to the next pipe function.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $myBase := "/a" -}}
|
|
{{- pathPipeJoin "b" "c" "a" }}
|
|
{{- pathPipeJoin "a" "b" "c" "/" }}
|
|
{{- $myBase | pathPipeJoin "b" "c" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a/b/c
|
|
/a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_gnrc_psj"><a class="link" href="#fn_path_gnrc_psj">4.5.1.3. <code>pathSliceJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">pathSliceJoin</span><span class="p">(</span><span class="n">sl</span> <span class="p">[]</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>pathSliceJoin</code> joins a slice of path segment strings (<code>[]string</code>) instead of a variadic sequence of strings.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>The <code>splitList</code> function shown below is from the <a href="https://masterminds.github.io/sprig/string_slice.html" target="_blank" rel="noopener"><code>sprig</code> string slice functions</a>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $myList := "a,b,c" | splitList "," -}}
|
|
{{- $myList | pathSliceJoin }}
|
|
{{- ("a,b,c" | splitList ",") | pathSliceJoin }}
|
|
{{- ("/,a,b,c" | splitList ",") | pathSliceJoin }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a/b/c
|
|
a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_gnrc_pspj"><a class="link" href="#fn_path_gnrc_pspj">4.5.1.4. <code>pathSlicePipeJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">pathSlicePipeJoin</span><span class="p">(</span><span class="n">sl</span> <span class="p">[]</span><span class="kt">string</span><span class="p">,</span> <span class="n">root</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>pathSlicePipeJoin</code> operates like <a href="#fn_path_gnrc_ppj"><code>pathPipeJoin</code></a> in that it is suitable for pipeline use in which the root/base path is passed in
|
|
from the pipeline, but it is like <a href="#fn_path_gnrc_psj"><code>pathSliceJoin</code></a> in that it then also accepts a slice of
|
|
path segments (<code>[]string</code>) to append to that base path.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>The <code>splitList</code> function shown below is from the <a href="https://masterminds.github.io/sprig/string_slice.html" target="_blank" rel="noopener"><code>sprig</code> string slice functions</a>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $myBase := "/a" -}}
|
|
{{- $myList := "b,c,d" | splitList "." -}}
|
|
{{- pathSlicePipeJoin $myList $myBase }}
|
|
{{- $myBase | pathSlicePipeJoin $myList }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">/a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_gnrc_psubj"><a class="link" href="#fn_path_gnrc_psubj">4.5.1.5. <code>pathSubJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">pathSubJoin</span><span class="p">(</span><span class="n">root</span> <span class="kt">string</span><span class="p">,</span> <span class="n">elems</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>pathSubJoin</code> operates like <a href="#fn_path_gnrc_pj"><code>pathJoin</code></a> but it expects an explicit root/base path.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The pipeline-friendly equivalent of this is <a href="#fn_path_gnrc_ppj"><code>pathPipeJoin</code></a>.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- pathSubJoin "/a/b" "c" }}
|
|
{{- pathSubJoin "/" "a" "b" "c" }}
|
|
{{- "c" | pathSubJoin "/" "a" "b" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">/a/b/c
|
|
/a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_path_os"><a class="link" href="#fn_path_os">4.5.2. OS/Platform-Tailored</a></h4>
|
|
<div class="paragraph">
|
|
<p>These operate similar to <a href="https://pkg.go.dev/path/filepath" target="_blank" rel="noopener">the <code>path/filepath</code> stdlib library</a>, and use the OS-specific <a href="https://pkg.go.dev/os#PathSeparator" target="_blank" rel="noopener"><code>os.PathSeparator</code></a>.</p>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>Take special note of the oddness around specifying Windows paths and drive letters in e.g. <a href="#fn_path_os_pj"><code>osPathJoin</code></a>!</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It is recommended to make use of <a href="#fn_sys_os"><code>sysOsName</code></a> to conditionally format path bases/roots if needed.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_os_pj"><a class="link" href="#fn_path_os_pj">4.5.2.1. <code>osPathJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osPathJoin</span><span class="p">(</span><span class="n">elem</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osPathJoin</code> directly calls <a href="https://pkg.go.dev/path/filepath#Join" target="_blank" rel="noopener"><code>path/filepath.Join</code></a>.</p>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>If you are joining paths in a pipeline, you almost assuredly want <a href="#fn_path_os_ppj"><code>osPathPipeJoin</code></a> or <a href="#fn_path_os_pspj"><code>osPathSlicePipeJoin</code></a> instead unless you are
|
|
explicitly <strong>appending</strong> a pipeline result to a path.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- osPathJoin "a" "b" "c" }}
|
|
{{- osPathJoin "/" "a" "b" "c" }}
|
|
{{- osPathJoin "C:\\" "a" "b" "c" }}
|
|
{{- osPathJoin "C:" "a" "b" "c" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 66.6667%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">OS</th>
|
|
<th class="tableblock halign-center valign-middle">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Windows</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a\b\c
|
|
\a\b\c
|
|
\a\b\c
|
|
C:\a\b\c
|
|
C:a\b\c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Others (e.g. Linux, macOS)</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a/b/c
|
|
/a/b/c
|
|
C:\/a/b/c
|
|
C:/a/b/c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_os_ppj"><a class="link" href="#fn_path_os_ppj">4.5.2.2. <code>osPathPipeJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osPathPipeJoin</span><span class="p">(</span><span class="n">elems</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osPathPipeJoin</code> operates like <a href="#fn_path_gnrc_ppj"><code>pathPipeJoin</code></a> (except using OS-specific path separators).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This makes it much more suitable for use in template pipelines, as the previous value in a pipeline is passed in
|
|
as the last argument to the next pipe function.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $myBase := "/a" -}}
|
|
{{- osPathPipeJoin "b" "c" "a" }}
|
|
{{- osPathPipeJoin "a" "b" "c" "/" }}
|
|
{{- $myBase | osPathPipeJoin "b" "c" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 66.6667%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">OS</th>
|
|
<th class="tableblock halign-center valign-middle">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Windows</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a\b\c
|
|
\a\b\c
|
|
\a\b\c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Others (e.g. Linux, macOS)</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a/b/c
|
|
/a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_ossep"><a class="link" href="#fn_path_ossep">4.5.2.3. <code>osPathSep</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osPathSep</span><span class="p">()</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osPathSep</code> returns the <a href="https://pkg.go.dev/os#PathSeparator" target="_blank" rel="noopener"><code>os.PathSeparator</code></a> for this OS.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- osPathSep }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 66.6667%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">OS</th>
|
|
<th class="tableblock halign-center valign-middle">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Windows</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">\</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Others (e.g. Linux, macOS)</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">/</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_os_psj"><a class="link" href="#fn_path_os_psj">4.5.2.4. <code>osPathSliceJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osPathSliceJoin</span><span class="p">(</span><span class="n">sl</span> <span class="p">[]</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osPathSliceJoin</code> operates like <a href="#fn_path_gnrc_psj"><code>pathSliceJoin</code></a> but with OS-specific path separators.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>The <code>splitList</code> function shown below is from the <a href="https://masterminds.github.io/sprig/string_slice.html" target="_blank" rel="noopener"><code>sprig</code> string slice functions</a>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $myList := "a,b,c" | splitList "," -}}
|
|
{{- $myList | osPathSliceJoin }}
|
|
{{- ("a,b,c" | splitList ",") | osPathSliceJoin }}
|
|
{{- ("/,a,b,c" | splitList ",") | osPathSliceJoin }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 66.6667%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">OS</th>
|
|
<th class="tableblock halign-center valign-middle">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Windows</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a\b\c
|
|
a\b\c
|
|
\a\b\c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Others (e.g. Linux, macOS)</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">a/b/c
|
|
a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_os_pspj"><a class="link" href="#fn_path_os_pspj">4.5.2.5. <code>osPathSlicePipeJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osPathSlicePipeJoin</span><span class="p">(</span><span class="n">sl</span> <span class="p">[]</span><span class="kt">string</span><span class="p">,</span> <span class="n">root</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osPathSlicePipeJoin</code> operates like <a href="#fn_path_gnrc_pspj"><code>pathSlicePipeJoin</code></a> but with OS-specific separators.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>The <code>splitList</code> function shown below is from the <a href="https://masterminds.github.io/sprig/string_slice.html" target="_blank" rel="noopener"><code>sprig</code> string slice functions</a>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $myBase := "/a" -}}
|
|
{{- $myList := "b,c,d" | splitList "." -}}
|
|
{{- osPathSlicePipeJoin $myList $myBase }}
|
|
{{- $myBase | osPathSlicePipeJoin $myList }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 66.6667%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">OS</th>
|
|
<th class="tableblock halign-center valign-middle">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Windows</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">\a\b\c\d
|
|
\a\b\c\d</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Others (e.g. Linux, macOS)</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">/a/b/c/d
|
|
/a/b/c/d</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_path_os_psubj"><a class="link" href="#fn_path_os_psubj">4.5.2.6. <code>osPathSubJoin</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">osPathSubJoin</span><span class="p">(</span><span class="n">root</span> <span class="kt">string</span><span class="p">,</span> <span class="n">elems</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>osPathSubJoin</code> operates like <a href="#fn_path_gnrc_psubj"><code>pathSubJoin</code></a> but with OS-specific separators.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The pipeline-friendly equivalent of this is <a href="#fn_path_os_ppj"><code>osPathPipeJoin</code></a>.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- osPathSubJoin "/a/b" "c" }}
|
|
{{- osPathSubJoin "/" "a" "b" "c" }}
|
|
{{- "c" | osPathSubJoin "/" "a" "b" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>renders as:</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 66.6667%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">OS</th>
|
|
<th class="tableblock halign-center valign-middle">Result</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Windows</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">\a\b\c
|
|
\a\b\c
|
|
\a\b\c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock">Others (e.g. Linux, macOS)</p></td>
|
|
<td class="tableblock halign-left valign-middle"><div class="content"><div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="text">/a/b/c
|
|
/a/b/c
|
|
/a/b/c</code></pre>
|
|
</div>
|
|
</div></div></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_ps"><a class="link" href="#fn_ps">4.6. PSUtil</a></h3>
|
|
<div class="paragraph">
|
|
<p>These are functions from <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4</code></a> packages.</p>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_cpu"><a class="link" href="#fn_ps_cpu">4.6.1. CPU/Processor</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_cpu_cnts"><a class="link" href="#fn_ps_cpu_cnts">4.6.1.1. <code>psCpuCnts</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psCpuCnts</span><span class="p">(</span><span class="n">logical</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">numCpu</span> <span class="kt">int</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psCpuCnts</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/cpu#Counts" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/cpu.Counts</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_cpu_info"><a class="link" href="#fn_ps_cpu_info">4.6.1.2. <code>psCpuInfo</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psCpuInfo</span><span class="p">()</span> <span class="p">(</span><span class="n">cpuInfo</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">cpu</span><span class="p">)</span><span class="o">.</span><span class="n">Info</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psCpuInfo</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/cpu#Info" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/cpu.Info</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_cpu_pct"><a class="link" href="#fn_ps_cpu_pct">4.6.1.3. <code>psCpuPct</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psCpuPct</span><span class="p">(</span><span class="n">interval</span> <span class="n">time</span><span class="o">.</span><span class="n">Duration</span><span class="p">,</span> <span class="n">percpu</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">pcts</span> <span class="p">[]</span><span class="kt">float64</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psCpuPct</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/cpu#Percent" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/cpu.Percent</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_cpu_tms"><a class="link" href="#fn_ps_cpu_tms">4.6.1.4. <code>psCpuTimes</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psCpuTimes</span><span class="p">(</span><span class="n">percpu</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">cpuTimes</span> <span class="p">[]</span><span class="n">TimesStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psCpuTimes</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/cpu#Times" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/cpu.Times</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_dsk"><a class="link" href="#fn_ps_dsk">4.6.2. Disk</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_dsk_iocnts"><a class="link" href="#fn_ps_dsk_iocnts">4.6.2.1. <code>psDiskIoCnts</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psDiskIoCnts</span><span class="p">(</span><span class="n">names</span> <span class="o">...</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">stats</span> <span class="k">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="n">IOCountersStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psDiskIoCnts</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/disk#IOCounters" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/disk.IOCounters</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_dsk_lbl"><a class="link" href="#fn_ps_dsk_lbl">4.6.2.2. <code>psDiskLabel</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psDiskLabel</span><span class="p">(</span><span class="n">name</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">label</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psDiskLabel</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/disk#Label" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/disk.Label</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_dsk_parts"><a class="link" href="#fn_ps_dsk_parts">4.6.2.3. <code>psDiskParts</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psDiskParts</span><span class="p">(</span><span class="n">all</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">parts</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">disk</span><span class="p">)</span><span class="o">.</span><span class="n">PartitionStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psDiskParts</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/disk#Partitions" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/disk.Partitions</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_dsk_srl"><a class="link" href="#fn_ps_dsk_srl">4.6.2.4. <code>psDiskSerial</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psDiskSerial</span><span class="p">(</span><span class="n">name</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">serial</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psDiskSerial</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/disk#SerialNumber" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/disk.SerialNumber</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_dsk_usg"><a class="link" href="#fn_ps_dsk_usg">4.6.2.5. <code>psDiskUsage</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psDiskUsage</span><span class="p">(</span><span class="n">path</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">usage</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">disk</span><span class="p">)</span><span class="o">.</span><span class="n">UsageStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psDiskUsage</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/disk#Usage" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/disk.Usage</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_hst"><a class="link" href="#fn_ps_hst">4.6.3. Host</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_boot"><a class="link" href="#fn_ps_hst_boot">4.6.3.1. <code>psHostBoot</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostBoot</span><span class="p">()</span> <span class="p">(</span><span class="n">bootEpoch</span> <span class="kt">uint64</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostBoot</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#BootTime" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.BootTime</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_id"><a class="link" href="#fn_ps_hst_id">4.6.3.2. <code>psHostId</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostId</span><span class="p">()</span> <span class="p">(</span><span class="n">hostId</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostId</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#HostID" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.HostID</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_info"><a class="link" href="#fn_ps_hst_info">4.6.3.3. <code>psHostInfo</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostInfo</span><span class="p">()</span> <span class="p">(</span><span class="n">info</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">host</span><span class="p">)</span><span class="o">.</span><span class="n">InfoStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostInfo</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#Info" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.Info</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_krnarch"><a class="link" href="#fn_ps_hst_krnarch">4.6.3.4. <code>psHostKernArch</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostKernArch</span><span class="p">()</span> <span class="p">(</span><span class="n">arch</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostKernArch</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#KernelArch" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.KernelArch</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_krnver"><a class="link" href="#fn_ps_hst_krnver">4.6.3.5. <code>psHostKernVer</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostKernVer</span><span class="p">()</span> <span class="p">(</span><span class="n">ver</span> <span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostKernVer</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#KernelVersion" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.KernelVersion</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_plat"><a class="link" href="#fn_ps_hst_plat">4.6.3.6. <code>psHostPlatInfo</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostPlatInfo</span><span class="p">()</span> <span class="p">(</span><span class="n">platInfo</span> <span class="p">[</span><span class="m">3</span><span class="p">]</span><span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostPlatInfo</code> wraps <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#PlatformInformation" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.PlatformInformation</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It is necessary to wrap because the function normally returns <code>(string, string, string, error)</code> but a template function may only return either a single value (of any type) or a single value of any type and an error, so the three <code>string</code> returns are consolidated into an ordered <code>[3]string</code>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_uptm"><a class="link" href="#fn_ps_hst_uptm">4.6.3.7. <code>psHostPlatUptime</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostPlatUptime</span><span class="p">()</span> <span class="p">(</span><span class="n">uptimeSecs</span> <span class="kt">uint64</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostPlatUptime</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#Uptime" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.Uptime</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_usrs"><a class="link" href="#fn_ps_hst_usrs">4.6.3.8. <code>psHostUsers</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostUsers</span><span class="p">()</span> <span class="p">(</span><span class="n">users</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">host</span><span class="p">)</span><span class="o">.</span><span class="n">UserStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostUsers</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#Users" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.Users</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_hst_virt"><a class="link" href="#fn_ps_hst_virt">4.6.3.9. <code>psHostPlatVirt</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psHostVirt</span><span class="p">()</span> <span class="p">(</span><span class="n">virtInfo</span> <span class="p">[</span><span class="m">2</span><span class="p">]</span><span class="kt">string</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psHostPlatVirt</code> wraps <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/host#Virtualization" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/host.Virtualization</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It is necessary to wrap because the function normally returns <code>(string, string, error)</code> but a template function may only return either a single value (of any type) or a single value of any type and an error, so the two <code>string</code> returns are consolidated into an ordered <code>[2]string</code>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_ld"><a class="link" href="#fn_ps_ld">4.6.4. Load</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_ld_avg"><a class="link" href="#fn_ps_ld_avg">4.6.4.1. <code>psLoadAvg</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psLoadAvg</span><span class="p">()</span> <span class="p">(</span><span class="n">avg</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">load</span><span class="p">)</span><span class="o">.</span><span class="n">AvgStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psLoadAvg</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/load#Avg" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/load.Avg</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_ld_misc"><a class="link" href="#fn_ps_ld_misc">4.6.4.2. <code>psLoadMisc</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psLoadMisc</span><span class="p">()</span> <span class="p">(</span><span class="n">misc</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">load</span><span class="p">)</span><span class="o">.</span><span class="n">MiscStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psLoadMisc</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/load#Misc" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/load.Misc</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_mem"><a class="link" href="#fn_ps_mem">4.6.5. Memory</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_mem_exvmem"><a class="link" href="#fn_ps_mem_exvmem">4.6.5.1. <code>psMemExVMem</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psMemExVMem</span><span class="p">()</span> <span class="p">(</span><span class="n">exVMem</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">mem</span><span class="p">)</span><span class="o">.</span><span class="n">ExVirtualMemory</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This function is available on Windows and Linux platforms <strong>only</strong>.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This function returns very different types depending on platform.</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Linux: <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem?GOOS=linux#ExVirtualMemory" target="_blank" rel="noopener"><code>mem.ExVirtualMemory</code></a></p>
|
|
</li>
|
|
<li>
|
|
<p>Windows: <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem?GOOS=windows#ExVirtualMemory" target="_blank" rel="noopener"><code>mem.ExVirtualMemory</code></a></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function wraps <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem?GOOS=linux#NewExLinux"><code>github.com/shirou/gopsutil/v4/mem.NewExLinux</code><sup></a>.<a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem?GOOS=linux#ExLinux.VirtualMemory"><code>VirtualMemory</code></sup></a> on Linux and
|
|
<a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem?GOOS=windows#NewExWindows"><code>github.com/shirou/gopsutil/v4/mem.NewExWindows</code><sup></a>.<a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem?GOOS=windows#ExWindows.VirtualMemory"><code>VirtualMemory</code></sup></a> on Windows.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_mem_swap"><a class="link" href="#fn_ps_mem_swap">4.6.5.2. <code>psMemSwap</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psMemSwap</span><span class="p">()</span> <span class="p">(</span><span class="n">swap</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">mem</span><span class="p">)</span><span class="o">.</span><span class="n">SwapMemoryStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psMemSwap</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem#SwapMemory" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/mem.SwapMemory</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_mem_swapdevs"><a class="link" href="#fn_ps_mem_swapdevs">4.6.5.3. <code>psMemSwapDevs</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psMemSwapDevs</span><span class="p">()</span> <span class="p">(</span><span class="n">swapDevs</span> <span class="p">[]</span><span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">mem</span><span class="p">)</span><span class="o">.</span><span class="n">SwapDevice</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psMemSwapDevs</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem#SwapDevices" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/mem.SwapDevices</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_mem_vmem"><a class="link" href="#fn_ps_mem_vmem">4.6.5.4. <code>psMemVMem</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psMemVMem</span><span class="p">()</span> <span class="p">(</span><span class="n">vmem</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">mem</span><span class="p">)</span><span class="o">.</span><span class="n">VirtualMemoryStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psMemVMem</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/mem#VirtualMemory" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/mem.VirtualMemory</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_net"><a class="link" href="#fn_ps_net">4.6.6. Network</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_conns"><a class="link" href="#fn_ps_net_conns">4.6.6.1. <code>psNetConns</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetConns</span><span class="p">(</span><span class="n">kind</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">conns</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ConnectionStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetConns</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#Connections" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.Connections</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_connsmax"><a class="link" href="#fn_ps_net_connsmax">4.6.6.2. <code>psNetConnsMax</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetConnsMax</span><span class="p">(</span><span class="n">kind</span> <span class="kt">string</span><span class="p">,</span> <span class="n">maxConn</span> <span class="kt">int</span><span class="p">)</span> <span class="p">(</span><span class="n">conns</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ConnectionStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetConnsMax</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#ConnectionsMax" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.ConnectionsMax</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_connspid"><a class="link" href="#fn_ps_net_connspid">4.6.6.3. <code>psNetConnsPid</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetConnsPid</span><span class="p">(</span><span class="n">kind</span> <span class="kt">string</span><span class="p">,</span> <span class="n">pid</span> <span class="kt">int32</span><span class="p">)</span> <span class="p">(</span><span class="n">conns</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ConnectionStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetConnsPid</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#ConnectionsPid" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.ConnectionsPid</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_connspidmax"><a class="link" href="#fn_ps_net_connspidmax">4.6.6.4. <code>psNetConnsPidMax</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetConnsPidMax</span><span class="p">(</span><span class="n">kind</span> <span class="kt">string</span><span class="p">,</span> <span class="n">pid</span> <span class="kt">int32</span><span class="p">,</span> <span class="n">maxConn</span> <span class="kt">int</span><span class="p">)</span> <span class="p">(</span><span class="n">conns</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ConnectionStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetConnsPidMax</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#ConnectionsPidMax" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.ConnectionsPidMax</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_ct"><a class="link" href="#fn_ps_net_ct">4.6.6.5. <code>psNetCTStats</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetCTStats</span><span class="p">(</span><span class="n">percCpu</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">ctStats</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ConntrackStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetCTStats</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#ConntrackStats" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.ConntrackStats</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_ctlist"><a class="link" href="#fn_ps_net_ctlist">4.6.6.6. <code>psNetCTStatList</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetCTStatList</span><span class="p">()</span> <span class="p">(</span><span class="n">ctStats</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ConntrackStatList</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetCTStatList</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#ConntrackStatList" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.ConntrackStatList</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_fltcnt"><a class="link" href="#fn_ps_net_fltcnt">4.6.6.7. <code>psNetFilterCnts</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetFilterCnts</span><span class="p">()</span> <span class="p">(</span><span class="n">filterCnts</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">FilterStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetFilterCnts</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#FilterCounters" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.FilterCounters</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_iocnts"><a class="link" href="#fn_ps_net_iocnts">4.6.6.8. <code>psNetIoCnts</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetIoCnts</span><span class="p">(</span><span class="n">perNIC</span> <span class="kt">bool</span><span class="p">)</span> <span class="p">(</span><span class="n">ioCnts</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">IOCountersStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetIoCnts</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#IOCounters" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.IOCounters</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_iocntsfl"><a class="link" href="#fn_ps_net_iocntsfl">4.6.6.9. <code>psNetIoCntsFile</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetIoCntsFile</span><span class="p">(</span><span class="n">perNIC</span> <span class="kt">bool</span><span class="p">,</span> <span class="n">filepath</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">ioCnts</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">IOCountersStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetIoCntsFile</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#IOCountersByFile" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.IOCountersByFile</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_ifaces"><a class="link" href="#fn_ps_net_ifaces">4.6.6.10. <code>psNetIfaces</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetIfaces</span><span class="p">()</span> <span class="p">(</span><span class="n">ioCnts</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">InterfaceStatList</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetIfaces</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#Interfaces" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.Interfaces</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_pids"><a class="link" href="#fn_ps_net_pids">4.6.6.11. <code>psNetPids</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetPids</span><span class="p">()</span> <span class="p">(</span><span class="n">pids</span> <span class="p">[]</span><span class="kt">int32</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetPids</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#Pids" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.Pids</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_protocnts"><a class="link" href="#fn_ps_net_protocnts">4.6.6.12. <code>psNetProtoCnt</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetProtoCnt</span><span class="p">(</span><span class="n">protos</span> <span class="p">[]</span><span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">protoCnts</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">net</span><span class="p">)</span><span class="o">.</span><span class="n">ProtoCountersStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This only works properly on Linux currently per upstream.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetProtoCnt</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net#ProtoCounters" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.ProtoCounters</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_net_rev"><a class="link" href="#fn_ps_net_rev">4.6.6.13. <code>psNetRev</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psNetRev</span><span class="p">(</span><span class="n">b</span> <span class="p">[]</span><span class="kt">byte</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="p">[]</span><span class="kt">byte</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This function only exists on Linux.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psNetRev</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/net?GOOS=linux#Reverse" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/net.Reverse</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_proc"><a class="link" href="#fn_ps_proc">4.6.7. Processes</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_procs_procs"><a class="link" href="#fn_ps_procs_procs">4.6.7.1. <code>psProcs</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psProcs</span><span class="p">(</span><span class="n">pid</span> <span class="kt">int32</span><span class="p">)</span> <span class="p">(</span><span class="n">procs</span> <span class="p">[]</span><span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">process</span><span class="p">)</span><span class="o">.</span><span class="n">Process</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psProcs</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/process#Processes" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/proc.Processes</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_proc_new"><a class="link" href="#fn_ps_proc_new">4.6.7.2. <code>psProcNew</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psProcNew</span><span class="p">(</span><span class="n">pid</span> <span class="kt">int32</span><span class="p">)</span> <span class="p">(</span><span class="n">proc</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">process</span><span class="p">)</span><span class="o">.</span><span class="n">Process</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psProcNew</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/process#NewProcess" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/proc.NewProcess</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_proc_pids"><a class="link" href="#fn_ps_proc_pids">4.6.7.3. <code>psProcPids</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psProcPids</span><span class="p">()</span> <span class="p">(</span><span class="n">pids</span> <span class="p">[]</span><span class="kt">int32</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psProcPids</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/process#Pids" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/proc.Pids</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_proc_pidxst"><a class="link" href="#fn_ps_proc_pidxst">4.6.7.4. <code>psProcPidExists</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psProcPidExists</span><span class="p">(</span><span class="n">pid</span> <span class="kt">int32</span><span class="p">)</span> <span class="p">(</span><span class="n">exists</span> <span class="kt">bool</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psProcPidExists</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/process#PidExists" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/proc.PidExists</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_sns"><a class="link" href="#fn_ps_sns">4.6.8. Sensors/Thermals</a></h4>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_sns_extemp"><a class="link" href="#fn_ps_sns_extemp">4.6.8.1. <code>psSensorExTemp</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psSensorExTemp</span><span class="p">()</span> <span class="p">(</span><span class="n">temps</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">sensors</span><span class="p">)</span><span class="o">.</span><span class="n">ExTemperature</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This function only exists on Linux.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psSensorExTemp</code> wraps <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/sensors?GOOS=linux#NewExLinux"><code>github.com/shirou/gopsutil/v4/sensors.NewExLinux</code><sup></a>.<a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/sensors?GOOS=linux#TemperatureWithContext"><code>github.com/shirou/gopsutil/v4/sensors.TemperatureWithContext</code></sup></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_sns_temps"><a class="link" href="#fn_ps_sns_temps">4.6.8.2. <code>psSensorTemps</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psSensorTemps</span><span class="p">()</span> <span class="p">(</span><span class="n">temps</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">sensors</span><span class="p">)</span><span class="o">.</span><span class="n">TemperatureStat</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psSensorTemps</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/sensors#SensorsTemperatures" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/sensors.SensorsTemperatures</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_ps_winsvc"><a class="link" href="#fn_ps_winsvc">4.6.9. Windows Services</a></h4>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>All of these functions are only available on Windows.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_winsvc_list"><a class="link" href="#fn_ps_winsvc_list">4.6.9.1. <code>psWinsvcList</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psWinsvcList</span><span class="p">()</span> <span class="p">(</span><span class="n">svcs</span> <span class="p">[](</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">winservices</span><span class="p">)</span><span class="o">.</span><span class="n">Service</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This function is only available on Windows.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psWinsvcList</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/winservices?GOOS=windows#ListServices" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/winservices.ListServices</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect4">
|
|
<h5 id="fn_ps_winsvc_new"><a class="link" href="#fn_ps_winsvc_new">4.6.9.2. <code>psWinsvcNew</code></a></h5>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">psWinsvcNew</span><span class="p">(</span><span class="n">svcName</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">svc</span> <span class="o">*</span><span class="p">(</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">shirou</span><span class="o">/</span><span class="n">gopsutil</span><span class="o">/</span><span class="n">v4</span><span class="o">/</span><span class="n">winservices</span><span class="p">)</span><span class="o">.</span><span class="n">Service</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="admonitionblock warning">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Warning</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>This function is only available on Windows.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>psWinsvcNew</code> directly calls <a href="https://pkg.go.dev/github.com/shirou/gopsutil/v4/winservices?GOOS=windows#NewService" target="_blank" rel="noopener"><code>github.com/shirou/gopsutil/v4/winservices.NewService</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_str"><a class="link" href="#fn_str">4.7. Strings</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_str_extindent"><a class="link" href="#fn_str_extindent">4.7.1. <code>extIndent</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">extIndent</span><span class="p">(</span>
|
|
<span class="n">levels</span> <span class="kt">int</span><span class="p">,</span>
|
|
<span class="n">skipFirst</span><span class="p">,</span> <span class="n">skipEmpty</span><span class="p">,</span> <span class="n">skipWhitespace</span> <span class="kt">bool</span><span class="p">,</span>
|
|
<span class="n">indentString</span><span class="p">,</span> <span class="n">input</span> <span class="kt">string</span><span class="p">,</span>
|
|
<span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>extIndent</code> allows for a MUCH more flexible indenter than the <code>sprig</code> <code>indent</code> function.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It works with both Windows (<code>\r\n</code>) and POSIX (<code>\n</code>) linebreaks.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>If <code><indentString></code> is set to <code>\n</code> and <code><levels></code> is always set to <code>1</code>, this function can even be used to doubelspace text!</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It has quite a few arguments, however:</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{ extIndent <levels> <skipFirst> <skipEmpty> <skipWhitespace> <indentString> <input> }}</code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Where:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code><levels></code>: The level of indentation for the text. If less than or equal to <code>0</code>, <code>extIndent</code> just returns <code><input></code> as-is and NO-OPs otherwise.</p>
|
|
</li>
|
|
<li>
|
|
<p><code><skipFirst></code>: If true, skip indenting the first line. This is particularly handy if you like to visually align your function calls in your templates.</p>
|
|
</li>
|
|
<li>
|
|
<p><code><skipEmpty></code>: If true, do not add an indent to <strong>empty</strong> lines (where an "empty line" means "only has a linebreak").</p>
|
|
</li>
|
|
<li>
|
|
<p><code><skipWhitespace></code>: If true, do not add an indent to lines that <strong>only</strong> consist of whitespace (spaces, tabs, etc.) and a linebreak.</p>
|
|
</li>
|
|
<li>
|
|
<p><code><indentString></code>: The string to use as the "indent character". This can be any string, such as <code>" "</code>, <code>"\t"</code>, <code>"."</code>, <code>"|"</code>, <code>"=="</code> etc.</p>
|
|
</li>
|
|
<li>
|
|
<p><code><input></code>: The text to be indented. Because it is the last argument, <code>extIndent</code> works with pipelined text as well.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_tm"><a class="link" href="#fn_tm">4.8. Time/Dates/Timestamps</a></h3>
|
|
<div class="admonitionblock note">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Note</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>Some of these functions duplicate Sprig functionality, but are included here for predictable API.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Care has been taken to name these functions differently from the Sprig functions where possible and sensible.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_date"><a class="link" href="#fn_tm_date">4.8.1. <code>tmDate</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmDate</span><span class="p">(</span><span class="n">year</span> <span class="kt">int</span><span class="p">,</span> <span class="n">month</span> <span class="n">time</span><span class="o">.</span><span class="n">Month</span><span class="p">,</span> <span class="n">day</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">min</span><span class="p">,</span> <span class="n">sec</span><span class="p">,</span> <span class="n">nsec</span> <span class="kt">int</span><span class="p">,</span> <span class="n">loc</span> <span class="o">*</span><span class="n">time</span><span class="o">.</span><span class="n">Location</span><span class="p">)</span> <span class="p">(</span><span class="n">date</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmDate</code> directly calls <a href="https://pkg.go.dev/time#Date" target="_blank" rel="noopener"><code>time.Date</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_fltmic"><a class="link" href="#fn_tm_fltmic">4.8.2. <code>tmFloatMicro</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmFloatMicro</span><span class="p">(</span><span class="n">t</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span> <span class="p">(</span><span class="n">f64</span> <span class="kt">float64</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmFloatMicro</code> directly calls <a href="https://pkg.go.dev/r00t2.io/goutils/timex#F64Microseconds" target="_blank" rel="noopener"><code>(r00t2.io/goutils/timex).F64Microseconds</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_fltmill"><a class="link" href="#fn_tm_fltmill">4.8.3. <code>tmFloatMilli</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmFloatMilli</span><span class="p">(</span><span class="n">t</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span> <span class="p">(</span><span class="n">f64</span> <span class="kt">float64</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmFloatMilli</code> directly calls <a href="https://pkg.go.dev/r00t2.io/goutils/timex#F64Milliseconds" target="_blank" rel="noopener"><code>(r00t2.io/goutils/timex).F64Milliseconds</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_fltnano"><a class="link" href="#fn_tm_fltnano">4.8.4. <code>tmFloatNano</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmFloatNano</span><span class="p">(</span><span class="n">t</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span> <span class="p">(</span><span class="n">f64</span> <span class="kt">float64</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmFloatNano</code> directly calls <a href="https://pkg.go.dev/r00t2.io/goutils/timex#F64Nanoseconds" target="_blank" rel="noopener"><code>(r00t2.io/goutils/timex).F64Nanoseconds</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_flt"><a class="link" href="#fn_tm_flt">4.8.5. <code>tmFloat</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmFloat</span><span class="p">(</span><span class="n">t</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span> <span class="p">(</span><span class="n">f64</span> <span class="kt">float64</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmFloat</code> directly calls <a href="https://pkg.go.dev/r00t2.io/goutils/timex#F64Seconds" target="_blank" rel="noopener"><code>(r00t2.io/goutils/timex).F64Seconds</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_fmt"><a class="link" href="#fn_tm_fmt">4.8.6. <code>tmFmt</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmFmt</span><span class="p">(</span><span class="n">fstr</span> <span class="kt">string</span><span class="p">,</span> <span class="n">t</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmFormat</code> provides a more pipeline-friendly alternative to calling e.g.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="gotemplate">{{- $t := tmNow -}}
|
|
{{ $t.Format "<some time format string>" }}</code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_now"><a class="link" href="#fn_tm_now">4.8.7. <code>tmNow</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmNow</span><span class="p">()</span> <span class="p">(</span><span class="n">now</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmNow</code> directly calls <a href="https://pkg.go.dev/time#Now" target="_blank" rel="noopener"><code>time.Now</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_pdur8n"><a class="link" href="#fn_tm_pdur8n">4.8.8. <code>tmParseDur8n</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmParseDur8n</span><span class="p">(</span><span class="n">s</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">d</span> <span class="n">time</span><span class="o">.</span><span class="n">Duration</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmParseDur8n</code> directly calls <a href="https://pkg.go.dev/time#ParseDuration" target="_blank" rel="noopener"><code>time.ParseDuration</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_pmnth"><a class="link" href="#fn_tm_pmnth">4.8.9. <code>tmParseMonth</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmParseMonth</span><span class="p">(</span><span class="n">v</span> <span class="n">any</span><span class="p">)</span> <span class="p">(</span><span class="n">mon</span> <span class="n">time</span><span class="o">.</span><span class="n">Month</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmParseMonth</code> attempts to first try <a href="#fn_tm_pmnthi"><code>tmParseMonthInt</code></a> and then tries <a href="#fn_tm_pmnths"><code>tmParseMonthStr</code></a> if <code>v</code> is not "numeric".</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_pmnthi"><a class="link" href="#fn_tm_pmnthi">4.8.10. <code>tmParseMonthInt</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmParseMonthInt</span><span class="p">(</span><span class="n">n</span> <span class="n">any</span><span class="p">)</span> <span class="p">(</span><span class="n">mon</span> <span class="n">time</span><span class="o">.</span><span class="n">Month</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmParseMonthInt</code> parses a number representation of month <code>n</code> to a <a href="https://pkg.go.dev/time#Month" target="_blank" rel="noopener"><code>time.Month</code></a>.
|
|
<code>n</code> may be any numeric type or a string representation of a number (or a custom type derived from those).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>A negative integer (or float, etc.) will be converted to a positive one (e.g. <code>-6</code> → <code>6</code> → <code>time.June</code>).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Floats are rounded to the nearest integer.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The integer should map directly to the <a href="https://pkg.go.dev/time#example-Month" target="_blank" rel="noopener"><code>time.Month</code> constants</a> in the <code>time</code> module:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><code>1</code>: <code>time.January</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>2</code>: <code>time.February</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>3</code>: <code>time.March</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>4</code>: <code>time.April</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>5</code>: <code>time.May</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>6</code>: <code>time.June</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>7</code>: <code>time.July</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>8</code>: <code>time.August</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>9</code>: <code>time.September</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>10</code>: <code>time.October</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>11</code>: <code>time.November</code></p>
|
|
</li>
|
|
<li>
|
|
<p><code>12</code>: <code>time.December</code></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>If <code>n</code> resolves to <code>0</code>, <code>mon</code> will be the current month (as determined by <a href="https://pkg.go.dev/time#Now" target="_blank" rel="noopener"><code>time.Now</code></a>).</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>If <code>n</code> resolves to > <code>12</code>, <code>err</code> will be <code>sprigx.ErrBadMonth</code> (though be sure to use <a href="https://pkg.go.dev/errors#Is" target="_blank" rel="noopener"><code>errors.Is</code></a>; it will be wrapped by <a href="https://pkg.go.dev/text/template#ExecError"><code>(text/template).ExecError</code></a>/<a href="https://pkg.go.dev/html/template#ExecError"><code>(html/template).ExecError</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_pmnths"><a class="link" href="#fn_tm_pmnths">4.8.11. <code>tmParseMonthStr</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmParseMonthStr</span><span class="p">(</span><span class="n">s</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">mon</span> <span class="n">time</span><span class="o">.</span><span class="n">Month</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmParseMonthStr</code> parses a string representation <code>s</code> of a month to a <a href="https://pkg.go.dev/time#Month" target="_blank" rel="noopener"><code>time.Month</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>It normalizes <code>s</code> to lowercase and only uses the first 3 characters (the minimum length needed to determine month name
|
|
uniqueness - "June" vs. "July", "March" vs. "May").</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>An empty (or whitespace-only) string will use the current month (as determined by <a href="https://pkg.go.dev/time#Now" target="_blank" rel="noopener"><code>time.Now</code></a>).`</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_tm_ptm"><a class="link" href="#fn_tm_ptm">4.8.12. <code>tmParseTime</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">tmParseTime</span><span class="p">(</span><span class="n">layout</span><span class="p">,</span> <span class="n">value</span> <span class="kt">string</span><span class="p">)</span> <span class="p">(</span><span class="n">t</span> <span class="n">time</span><span class="o">.</span><span class="n">Time</span><span class="p">,</span> <span class="n">err</span> <span class="kt">error</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>tmParseTime</code> directly calls <a href="https://pkg.go.dev/time#Parse" target="_blank" rel="noopener"><code>time.Parse</code></a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Be sure that <code>layout</code> is a properly parseable <a href="https://pkg.go.dev/time#Layout" target="_blank" rel="noopener">layout format</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="fn_sys"><a class="link" href="#fn_sys">4.9. System/Platform/Architecture</a></h3>
|
|
<div class="sect3">
|
|
<h4 id="fn_sys_arch"><a class="link" href="#fn_sys_arch">4.9.1. <code>sysArch</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">sysArch</span><span class="p">()</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Returns the <a href="https://pkg.go.dev/runtime#GOARCH" target="_blank" rel="noopener"><code>runtime.GOARCH</code></a> constant.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_sys_numcpu"><a class="link" href="#fn_sys_numcpu">4.9.2. <code>sysNumCpu</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">sysNumCpu</span><span class="p">()</span> <span class="p">(</span><span class="n">cnt</span> <span class="kt">int</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p><code>sysNumCpu</code> directly calls <a href="https://pkg.go.dev/runtime#NumCPU" target="_blank" rel="noopener"><code>runtime.NumCPU</code></a>.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_sys_os"><a class="link" href="#fn_sys_os">4.9.3. <code>sysOsName</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">sysOsNm</span><span class="p">()</span> <span class="p">(</span><span class="n">out</span> <span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Returns the <a href="https://pkg.go.dev/runtime#GOOS" target="_blank" rel="noopener"><code>runtime.GOOS</code></a> constant.</p>
|
|
</div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="fn_sys_rntm"><a class="link" href="#fn_sys_rntm">4.9.4. <code>sysRuntime</code></a></h4>
|
|
<div class="listingblock">
|
|
<div class="title">Function Signature</div>
|
|
<div class="content">
|
|
<pre class="rouge highlight"><code data-lang="go"><span class="k">func</span> <span class="n">sysRuntime</span><span class="p">()</span> <span class="p">(</span><span class="n">out</span> <span class="k">map</span><span class="p">[</span><span class="kt">string</span><span class="p">]</span><span class="kt">string</span><span class="p">)</span></code></pre>
|
|
</div>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>This function returns a <code>map[string]string</code> of various information from the <a href="https://pkg.go.dev/runtime" target="_blank" rel="noopener"><code>runtime</code> stdlib library</a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Specifically, the following are returned.</p>
|
|
</div>
|
|
<div class="admonitionblock tip">
|
|
<table>
|
|
<tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="paragraph">
|
|
<p>The value type is a direct link to the <code>runtime</code> documentation providing more detail about the associated value.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Because all values are mapped as strings, they can be converted back to their native type via e.g. the <a href="https://masterminds.github.io/sprig/conversion.html" target="_blank" rel="noopener">Sprig conversion functions</a> if necessary.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<caption class="title">Table 1. <code>sysRuntime</code> Values</caption>
|
|
<colgroup>
|
|
<col style="width: 50%;">
|
|
<col style="width: 50%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-center valign-middle">Key</th>
|
|
<th class="tableblock halign-center valign-middle">Value Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>compiler</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#Compiler" target="_blank" rel="noopener">string</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>arch</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#GOARCH" target="_blank" rel="noopener">string</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>os</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#GOOS" target="_blank" rel="noopener">string</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>maxprocs</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#GOMAXPROCS" target="_blank" rel="noopener">int</a> <sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>cpu_cnt</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#NumCPU" target="_blank" rel="noopener">int</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>num_cgo</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#NumCgoCall" target="_blank" rel="noopener">int</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>num_go</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#NumGoroutine" target="_blank" rel="noopener">int</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><code>go_ver</code></p></td>
|
|
<td class="tableblock halign-center valign-middle"><p class="tableblock"><a href="https://pkg.go.dev/runtime#Version" target="_blank" rel="noopener">string</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="paragraph">
|
|
<p>As a convenience, some of these values also have their own dedicated functions as well:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><a href="#fn_sys_arch"><code>sysArch</code></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="#fn_sys_numcpu"><code>sysNumCpu</code></a></p>
|
|
</li>
|
|
<li>
|
|
<p><a href="#fn_sys_os"><code>sysOsName</code></a></p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footnotes">
|
|
<hr>
|
|
<div class="footnote" id="_footnotedef_1">
|
|
<a href="#_footnoteref_1">1</a>. For safety concerns, <code>sprigx</code> does not allow <strong>setting</strong> <code>GOMAXPROCS</code>, this value only contains the <strong>current</strong> <code>GOMAXPROCS</code> value.
|
|
</div>
|
|
</div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated 2026-01-30 06:49:10 -0500
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |