| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `types/src/function.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>function.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../teaclave_types/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../teaclave_types/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| </pre><pre class="rust"><code><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| </span><span class="kw">use crate</span>::{ExecutorType, Storable, UserID}; |
| <span class="kw">use </span>serde::{Deserialize, Serialize}; |
| <span class="kw">use </span>uuid::Uuid; |
| |
| <span class="attribute">#[derive(Debug, Deserialize, Serialize)] |
| </span><span class="kw">pub struct </span>FunctionInput { |
| <span class="kw">pub </span>name: String, |
| <span class="kw">pub </span>description: String, |
| <span class="kw">pub </span>optional: bool, |
| } |
| |
| <span class="kw">impl </span>FunctionInput { |
| <span class="kw">pub fn </span>new(name: <span class="kw">impl </span>Into<String>, description: <span class="kw">impl </span>Into<String>, optional: bool) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| name: name.into(), |
| description: description.into(), |
| optional, |
| } |
| } |
| } |
| |
| <span class="attribute">#[derive(Debug, Deserialize, Serialize)] |
| </span><span class="kw">pub struct </span>FunctionOutput { |
| <span class="kw">pub </span>name: String, |
| <span class="kw">pub </span>description: String, |
| <span class="kw">pub </span>optional: bool, |
| } |
| |
| <span class="kw">impl </span>FunctionOutput { |
| <span class="kw">pub fn </span>new(name: <span class="kw">impl </span>Into<String>, description: <span class="kw">impl </span>Into<String>, optional: bool) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| name: name.into(), |
| description: description.into(), |
| optional, |
| } |
| } |
| } |
| |
| <span class="kw">const </span>USER_PREFIX: <span class="kw-2">&</span>str = <span class="string">"user"</span>; |
| |
| <span class="attribute">#[derive(Default, Debug, Deserialize, Serialize)] |
| </span><span class="kw">pub struct </span>User { |
| <span class="kw">pub </span>id: UserID, |
| <span class="kw">pub </span>registered_functions: Vec<String>, |
| <span class="kw">pub </span>allowed_functions: Vec<String>, |
| } |
| |
| <span class="kw">impl </span>Storable <span class="kw">for </span>User { |
| <span class="kw">fn </span>key_prefix() -> <span class="kw-2">&</span><span class="lifetime">'static </span>str { |
| USER_PREFIX |
| } |
| |
| <span class="kw">fn </span>uuid(<span class="kw-2">&</span><span class="self">self</span>) -> Uuid { |
| Uuid::new_v5(<span class="kw-2">&</span>Uuid::NAMESPACE_DNS, <span class="self">self</span>.id.to_string().as_bytes()) |
| } |
| } |
| |
| <span class="kw">const </span>FUNCION_PREFIX: <span class="kw-2">&</span>str = <span class="string">"function"</span>; |
| |
| <span class="attribute">#[derive(Default, Debug, Deserialize, Serialize)] |
| </span><span class="kw">pub struct </span>Function { |
| <span class="kw">pub </span>id: Uuid, |
| <span class="kw">pub </span>name: String, |
| <span class="kw">pub </span>description: String, |
| <span class="kw">pub </span>public: bool, |
| <span class="kw">pub </span>executor_type: ExecutorType, |
| <span class="kw">pub </span>payload: Vec<u8>, |
| <span class="kw">pub </span>arguments: Vec<FunctionArgument>, |
| <span class="kw">pub </span>inputs: Vec<FunctionInput>, |
| <span class="kw">pub </span>outputs: Vec<FunctionOutput>, |
| <span class="kw">pub </span>owner: UserID, |
| <span class="kw">pub </span>user_allowlist: Vec<String>, |
| <span class="kw">pub </span>usage_quota: <span class="prelude-ty">Option</span><i32>, |
| } |
| |
| <span class="attribute">#[derive(Default)] |
| </span><span class="kw">pub struct </span>FunctionBuilder { |
| function: Function, |
| } |
| |
| <span class="kw">impl </span>FunctionBuilder { |
| <span class="kw">pub fn </span>new() -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| function: Function::default(), |
| } |
| } |
| |
| <span class="kw">pub fn </span>id(<span class="kw-2">mut </span><span class="self">self</span>, id: Uuid) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.id = id; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>executor_type(<span class="kw-2">mut </span><span class="self">self</span>, executor_type: ExecutorType) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.executor_type = executor_type; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>name(<span class="kw-2">mut </span><span class="self">self</span>, name: <span class="kw">impl </span>ToString) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.name = name.to_string(); |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>description(<span class="kw-2">mut </span><span class="self">self</span>, description: <span class="kw">impl </span>ToString) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.description = description.to_string(); |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>payload(<span class="kw-2">mut </span><span class="self">self</span>, payload: Vec<u8>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.payload = payload; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>public(<span class="kw-2">mut </span><span class="self">self</span>, public: bool) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.public = public; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>arguments(<span class="kw-2">mut </span><span class="self">self</span>, arguments: Vec<FunctionArgument>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.arguments = arguments; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>inputs(<span class="kw-2">mut </span><span class="self">self</span>, inputs: Vec<FunctionInput>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.inputs = inputs; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>outputs(<span class="kw-2">mut </span><span class="self">self</span>, outputs: Vec<FunctionOutput>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.outputs = outputs; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>owner(<span class="kw-2">mut </span><span class="self">self</span>, owner: <span class="kw">impl </span>Into<UserID>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.owner = owner.into(); |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>user_allowlist(<span class="kw-2">mut </span><span class="self">self</span>, user_allowlist: Vec<String>) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.function.user_allowlist = user_allowlist; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>usage_quota(<span class="kw-2">mut </span><span class="self">self</span>, usage_quota: <span class="prelude-ty">Option</span><i32>) -> <span class="self">Self </span>{ |
| <span class="kw">let </span>usage_quota = <span class="kw">match </span>usage_quota { |
| <span class="prelude-val">Some</span>(quota) <span class="kw">if </span>quota < <span class="number">0 </span>=> <span class="prelude-val">None</span>, |
| <span class="kw">_ </span>=> usage_quota, |
| }; |
| |
| <span class="self">self</span>.function.usage_quota = usage_quota; |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">pub fn </span>build(<span class="self">self</span>) -> Function { |
| <span class="self">self</span>.function |
| } |
| } |
| |
| <span class="kw">impl </span>Storable <span class="kw">for </span>Function { |
| <span class="kw">fn </span>key_prefix() -> <span class="kw-2">&</span><span class="lifetime">'static </span>str { |
| FUNCION_PREFIX |
| } |
| |
| <span class="kw">fn </span>uuid(<span class="kw-2">&</span><span class="self">self</span>) -> Uuid { |
| <span class="self">self</span>.id |
| } |
| } |
| |
| <span class="attribute">#[derive(Debug, Deserialize, Serialize, Clone)] |
| </span><span class="kw">pub struct </span>FunctionArgument { |
| <span class="kw">pub </span>key: String, |
| <span class="kw">pub </span>default_value: String, |
| <span class="kw">pub </span>allow_overwrite: bool, |
| } |
| |
| <span class="kw">impl </span>FunctionArgument { |
| <span class="kw">pub fn </span>new( |
| key: <span class="kw">impl </span>Into<String>, |
| default_value: <span class="kw">impl </span>Into<String>, |
| allow_overwrite: bool, |
| ) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| key: key.into(), |
| default_value: default_value.into(), |
| allow_overwrite, |
| } |
| } |
| } |
| |
| <span class="kw">const </span>FUNCION_USAGE_PREFIX: <span class="kw-2">&</span>str = <span class="string">"usage"</span>; |
| |
| <span class="attribute">#[derive(Default, Debug, Deserialize, Serialize)] |
| </span><span class="kw">pub struct </span>FunctionUsage { |
| <span class="kw">pub </span>function_id: Uuid, |
| <span class="kw">pub </span>use_numbers: i32, |
| } |
| |
| <span class="kw">impl </span>Storable <span class="kw">for </span>FunctionUsage { |
| <span class="kw">fn </span>key_prefix() -> <span class="kw-2">&</span><span class="lifetime">'static </span>str { |
| FUNCION_USAGE_PREFIX |
| } |
| |
| <span class="kw">fn </span>uuid(<span class="kw-2">&</span><span class="self">self</span>) -> Uuid { |
| <span class="self">self</span>.function_id |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="teaclave_types" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
