blob: c1a09bd60d04d936b3e4ea3c9ff47dce10ce48a4 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/services/vercel_artifacts/builder.rs`."><title>builder.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-916cea96.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="opendal" data-themes="" data-resource-suffix="" data-rustdoc-version="1.87.0-nightly (43a2e9d2c 2025-03-17)" data-channel="nightly" data-search-js="search-e7298875.js" data-settings-js="settings-d72f25bb.js" ><script src="../../../../static.files/storage-d8ac8691.js"></script><script defer src="../../../../static.files/src-script-b8d3f215.js"></script><script defer src="../../../../src-files.js"></script><script defer src="../../../../static.files/main-fb8c74a8.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">opendal/services/vercel_artifacts/</div>builder.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Licensed to the Apache Software Foundation (ASF) under one
<a href=#2 id=2 data-nosnippet>2</a>// or more contributor license agreements. See the NOTICE file
<a href=#3 id=3 data-nosnippet>3</a>// distributed with this work for additional information
<a href=#4 id=4 data-nosnippet>4</a>// regarding copyright ownership. The ASF licenses this file
<a href=#5 id=5 data-nosnippet>5</a>// to you under the Apache License, Version 2.0 (the
<a href=#6 id=6 data-nosnippet>6</a>// "License"); you may not use this file except in compliance
<a href=#7 id=7 data-nosnippet>7</a>// with the License. You may obtain a copy of the License at
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#10 id=10 data-nosnippet>10</a>//
<a href=#11 id=11 data-nosnippet>11</a>// Unless required by applicable law or agreed to in writing,
<a href=#12 id=12 data-nosnippet>12</a>// software distributed under the License is distributed on an
<a href=#13 id=13 data-nosnippet>13</a>// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
<a href=#14 id=14 data-nosnippet>14</a>// KIND, either express or implied. See the License for the
<a href=#15 id=15 data-nosnippet>15</a>// specific language governing permissions and limitations
<a href=#16 id=16 data-nosnippet>16</a>// under the License.
<a href=#17 id=17 data-nosnippet>17</a>
<a href=#18 id=18 data-nosnippet>18</a></span><span class="kw">use </span>std::fmt::Debug;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>std::fmt::Formatter;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>std::sync::Arc;
<a href=#21 id=21 data-nosnippet>21</a>
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span><span class="kw">super</span>::backend::VercelArtifactsBackend;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span><span class="kw">super</span>::core::VercelArtifactsCore;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span><span class="kw">crate</span>::raw::HttpClient;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span><span class="kw">crate</span>::raw::{Access, AccessorInfo};
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span><span class="kw">crate</span>::services::VercelArtifactsConfig;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">use </span><span class="kw">crate</span>::Scheme;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">use crate</span>::<span class="kw-2">*</span>;
<a href=#29 id=29 data-nosnippet>29</a>
<a href=#30 id=30 data-nosnippet>30</a><span class="kw">impl </span>Configurator <span class="kw">for </span>VercelArtifactsConfig {
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">type </span>Builder = VercelArtifactsBuilder;
<a href=#32 id=32 data-nosnippet>32</a>
<a href=#33 id=33 data-nosnippet>33</a> <span class="attr">#[allow(deprecated)]
<a href=#34 id=34 data-nosnippet>34</a> </span><span class="kw">fn </span>into_builder(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Builder {
<a href=#35 id=35 data-nosnippet>35</a> VercelArtifactsBuilder {
<a href=#36 id=36 data-nosnippet>36</a> config: <span class="self">self</span>,
<a href=#37 id=37 data-nosnippet>37</a> http_client: <span class="prelude-val">None</span>,
<a href=#38 id=38 data-nosnippet>38</a> }
<a href=#39 id=39 data-nosnippet>39</a> }
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="doccomment">/// [Vercel Cache](https://vercel.com/docs/concepts/monorepos/remote-caching) backend support.
<a href=#43 id=43 data-nosnippet>43</a></span><span class="attr">#[doc = <span class="macro">include_str!</span>(<span class="string">"docs.md"</span>)]
<a href=#44 id=44 data-nosnippet>44</a>#[derive(Default)]
<a href=#45 id=45 data-nosnippet>45</a></span><span class="kw">pub struct </span>VercelArtifactsBuilder {
<a href=#46 id=46 data-nosnippet>46</a> config: VercelArtifactsConfig,
<a href=#47 id=47 data-nosnippet>47</a>
<a href=#48 id=48 data-nosnippet>48</a> <span class="attr">#[deprecated(since = <span class="string">"0.53.0"</span>, note = <span class="string">"Use `Operator::update_http_client` instead"</span>)]
<a href=#49 id=49 data-nosnippet>49</a> </span>http_client: <span class="prelude-ty">Option</span>&lt;HttpClient&gt;,
<a href=#50 id=50 data-nosnippet>50</a>}
<a href=#51 id=51 data-nosnippet>51</a>
<a href=#52 id=52 data-nosnippet>52</a><span class="kw">impl </span>Debug <span class="kw">for </span>VercelArtifactsBuilder {
<a href=#53 id=53 data-nosnippet>53</a> <span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>Formatter&lt;<span class="lifetime">'_</span>&gt;) -&gt; std::fmt::Result {
<a href=#54 id=54 data-nosnippet>54</a> <span class="kw">let </span><span class="kw-2">mut </span>d = f.debug_struct(<span class="string">"VercelArtifactsBuilder"</span>);
<a href=#55 id=55 data-nosnippet>55</a> d.field(<span class="string">"config"</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.config);
<a href=#56 id=56 data-nosnippet>56</a> d.finish_non_exhaustive()
<a href=#57 id=57 data-nosnippet>57</a> }
<a href=#58 id=58 data-nosnippet>58</a>}
<a href=#59 id=59 data-nosnippet>59</a>
<a href=#60 id=60 data-nosnippet>60</a><span class="kw">impl </span>VercelArtifactsBuilder {
<a href=#61 id=61 data-nosnippet>61</a> <span class="doccomment">/// set the bearer access token for Vercel
<a href=#62 id=62 data-nosnippet>62</a> ///
<a href=#63 id=63 data-nosnippet>63</a> /// default: no access token, which leads to failure
<a href=#64 id=64 data-nosnippet>64</a> </span><span class="kw">pub fn </span>access_token(<span class="kw-2">mut </span><span class="self">self</span>, access_token: <span class="kw-2">&amp;</span>str) -&gt; <span class="self">Self </span>{
<a href=#65 id=65 data-nosnippet>65</a> <span class="self">self</span>.config.access_token = <span class="prelude-val">Some</span>(access_token.to_string());
<a href=#66 id=66 data-nosnippet>66</a> <span class="self">self
<a href=#67 id=67 data-nosnippet>67</a> </span>}
<a href=#68 id=68 data-nosnippet>68</a>
<a href=#69 id=69 data-nosnippet>69</a> <span class="doccomment">/// Specify the http client that used by this service.
<a href=#70 id=70 data-nosnippet>70</a> ///
<a href=#71 id=71 data-nosnippet>71</a> /// # Notes
<a href=#72 id=72 data-nosnippet>72</a> ///
<a href=#73 id=73 data-nosnippet>73</a> /// This API is part of OpenDAL's Raw API. `HttpClient` could be changed
<a href=#74 id=74 data-nosnippet>74</a> /// during minor updates.
<a href=#75 id=75 data-nosnippet>75</a> </span><span class="attr">#[deprecated(since = <span class="string">"0.53.0"</span>, note = <span class="string">"Use `Operator::update_http_client` instead"</span>)]
<a href=#76 id=76 data-nosnippet>76</a> #[allow(deprecated)]
<a href=#77 id=77 data-nosnippet>77</a> </span><span class="kw">pub fn </span>http_client(<span class="kw-2">mut </span><span class="self">self</span>, http_client: HttpClient) -&gt; <span class="self">Self </span>{
<a href=#78 id=78 data-nosnippet>78</a> <span class="self">self</span>.http_client = <span class="prelude-val">Some</span>(http_client);
<a href=#79 id=79 data-nosnippet>79</a> <span class="self">self
<a href=#80 id=80 data-nosnippet>80</a> </span>}
<a href=#81 id=81 data-nosnippet>81</a>}
<a href=#82 id=82 data-nosnippet>82</a>
<a href=#83 id=83 data-nosnippet>83</a><span class="kw">impl </span>Builder <span class="kw">for </span>VercelArtifactsBuilder {
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">const </span>SCHEME: Scheme = Scheme::VercelArtifacts;
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">type </span>Config = VercelArtifactsConfig;
<a href=#86 id=86 data-nosnippet>86</a>
<a href=#87 id=87 data-nosnippet>87</a> <span class="kw">fn </span>build(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="kw">impl </span>Access&gt; {
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">let </span>info = AccessorInfo::default();
<a href=#89 id=89 data-nosnippet>89</a> info.set_scheme(Scheme::VercelArtifacts)
<a href=#90 id=90 data-nosnippet>90</a> .set_native_capability(Capability {
<a href=#91 id=91 data-nosnippet>91</a> stat: <span class="bool-val">true</span>,
<a href=#92 id=92 data-nosnippet>92</a> stat_has_cache_control: <span class="bool-val">true</span>,
<a href=#93 id=93 data-nosnippet>93</a> stat_has_content_length: <span class="bool-val">true</span>,
<a href=#94 id=94 data-nosnippet>94</a> stat_has_content_type: <span class="bool-val">true</span>,
<a href=#95 id=95 data-nosnippet>95</a> stat_has_content_encoding: <span class="bool-val">true</span>,
<a href=#96 id=96 data-nosnippet>96</a> stat_has_content_range: <span class="bool-val">true</span>,
<a href=#97 id=97 data-nosnippet>97</a> stat_has_etag: <span class="bool-val">true</span>,
<a href=#98 id=98 data-nosnippet>98</a> stat_has_content_md5: <span class="bool-val">true</span>,
<a href=#99 id=99 data-nosnippet>99</a> stat_has_last_modified: <span class="bool-val">true</span>,
<a href=#100 id=100 data-nosnippet>100</a> stat_has_content_disposition: <span class="bool-val">true</span>,
<a href=#101 id=101 data-nosnippet>101</a>
<a href=#102 id=102 data-nosnippet>102</a> read: <span class="bool-val">true</span>,
<a href=#103 id=103 data-nosnippet>103</a>
<a href=#104 id=104 data-nosnippet>104</a> write: <span class="bool-val">true</span>,
<a href=#105 id=105 data-nosnippet>105</a>
<a href=#106 id=106 data-nosnippet>106</a> shared: <span class="bool-val">true</span>,
<a href=#107 id=107 data-nosnippet>107</a>
<a href=#108 id=108 data-nosnippet>108</a> ..Default::default()
<a href=#109 id=109 data-nosnippet>109</a> });
<a href=#110 id=110 data-nosnippet>110</a>
<a href=#111 id=111 data-nosnippet>111</a> <span class="comment">// allow deprecated api here for compatibility
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="attr">#[allow(deprecated)]
<a href=#113 id=113 data-nosnippet>113</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(client) = <span class="self">self</span>.http_client {
<a href=#114 id=114 data-nosnippet>114</a> info.update_http_client(|<span class="kw">_</span>| client);
<a href=#115 id=115 data-nosnippet>115</a> }
<a href=#116 id=116 data-nosnippet>116</a>
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">match </span><span class="self">self</span>.config.access_token.clone() {
<a href=#118 id=118 data-nosnippet>118</a> <span class="prelude-val">Some</span>(access_token) =&gt; <span class="prelude-val">Ok</span>(VercelArtifactsBackend {
<a href=#119 id=119 data-nosnippet>119</a> core: Arc::new(VercelArtifactsCore {
<a href=#120 id=120 data-nosnippet>120</a> info: Arc::new(info),
<a href=#121 id=121 data-nosnippet>121</a> access_token,
<a href=#122 id=122 data-nosnippet>122</a> }),
<a href=#123 id=123 data-nosnippet>123</a> }),
<a href=#124 id=124 data-nosnippet>124</a> <span class="prelude-val">None </span>=&gt; <span class="prelude-val">Err</span>(Error::new(ErrorKind::ConfigInvalid, <span class="string">"access_token not set"</span>)),
<a href=#125 id=125 data-nosnippet>125</a> }
<a href=#126 id=126 data-nosnippet>126</a> }
<a href=#127 id=127 data-nosnippet>127</a>}</code></pre></div></section></main></body></html>