<!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/config/screenshot.rs`."><title>screenshot.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="scrapfly_sdk" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../../../static.files/src-script-56102188.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-5f194d8c.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">scrapfly_sdk/config/</div>screenshot.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a></pre></div><pre class="rust"><code><span class="doccomment">//! Screenshot endpoint configuration — ported from `sdk/go/config_screenshot.go`.
</span><span class="kw">use </span><span class="kw">crate</span>::enums::{ScreenshotFormat, ScreenshotOption, VisionDeficiencyType};
<span class="kw">use </span><span class="kw">crate</span>::error::ScrapflyError;
<span class="kw">use </span><span class="kw">super</span>::url_safe_b64_encode;
<span class="doccomment">/// Configuration for a `POST /screenshot` request.
</span><span class="attr">#[derive(Debug, Clone, Default)]
</span><span class="kw">pub struct </span>ScreenshotConfig {
<span class="doccomment">/// Target URL (required).
</span><span class="kw">pub </span>url: String,
<span class="doccomment">/// Image format.
</span><span class="kw">pub </span>format: <span class="prelude-ty">Option</span><ScreenshotFormat>,
<span class="doccomment">/// `fullpage` or a CSS selector.
</span><span class="kw">pub </span>capture: <span class="prelude-ty">Option</span><String>,
<span class="doccomment">/// Viewport resolution (e.g. `1920x1080`).
</span><span class="kw">pub </span>resolution: <span class="prelude-ty">Option</span><String>,
<span class="doccomment">/// Proxy country.
</span><span class="kw">pub </span>country: <span class="prelude-ty">Option</span><String>,
<span class="doccomment">/// Timeout in milliseconds.
</span><span class="kw">pub </span>timeout: <span class="prelude-ty">Option</span><u32>,
<span class="doccomment">/// Extra rendering wait (ms).
</span><span class="kw">pub </span>rendering_wait: <span class="prelude-ty">Option</span><u32>,
<span class="doccomment">/// Wait for CSS selector.
</span><span class="kw">pub </span>wait_for_selector: <span class="prelude-ty">Option</span><String>,
<span class="doccomment">/// Capture options.
</span><span class="kw">pub </span>options: Vec<ScreenshotOption>,
<span class="doccomment">/// Enable auto-scroll.
</span><span class="kw">pub </span>auto_scroll: bool,
<span class="doccomment">/// Custom JavaScript (base64url-encoded on the wire).
</span><span class="kw">pub </span>js: <span class="prelude-ty">Option</span><String>,
<span class="doccomment">/// Enable cache.
</span><span class="kw">pub </span>cache: bool,
<span class="doccomment">/// Cache TTL (seconds).
</span><span class="kw">pub </span>cache_ttl: <span class="prelude-ty">Option</span><u32>,
<span class="doccomment">/// Force cache refresh.
</span><span class="kw">pub </span>cache_clear: bool,
<span class="doccomment">/// Webhook name.
</span><span class="kw">pub </span>webhook: <span class="prelude-ty">Option</span><String>,
<span class="doccomment">/// Simulated vision deficiency.
</span><span class="kw">pub </span>vision_deficiency: <span class="prelude-ty">Option</span><VisionDeficiencyType>,
}
<span class="kw">impl </span>ScreenshotConfig {
<span class="doccomment">/// Start a builder for `url`.
</span><span class="kw">pub fn </span>builder(url: <span class="kw">impl </span>Into<String>) -> ScreenshotConfigBuilder {
ScreenshotConfigBuilder {
cfg: ScreenshotConfig {
url: url.into(),
..Default::default()
},
}
}
<span class="doccomment">/// Serialize into query-param pairs. Mirrors `toAPIParams` in the Go SDK.
</span><span class="kw">pub fn </span>to_query_pairs(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Result</span><Vec<(String, String)>, ScrapflyError> {
<span class="kw">if </span><span class="self">self</span>.url.is_empty() {
<span class="kw">return </span><span class="prelude-val">Err</span>(ScrapflyError::Config(<span class="string">"url is required"</span>.into()));
}
<span class="kw">let </span><span class="kw-2">mut </span>out: Vec<(String, String)> = Vec::new();
out.push((<span class="string">"url"</span>.into(), <span class="self">self</span>.url.clone()));
<span class="kw">if let </span><span class="prelude-val">Some</span>(f) = <span class="self">self</span>.format {
out.push((<span class="string">"format"</span>.into(), f.as_str().into()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(c) = <span class="kw-2">&</span><span class="self">self</span>.capture {
out.push((<span class="string">"capture"</span>.into(), c.clone()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(r) = <span class="kw-2">&</span><span class="self">self</span>.resolution {
out.push((<span class="string">"resolution"</span>.into(), r.clone()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(c) = <span class="kw-2">&</span><span class="self">self</span>.country {
out.push((<span class="string">"country"</span>.into(), c.clone()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(t) = <span class="self">self</span>.timeout {
out.push((<span class="string">"timeout"</span>.into(), t.to_string()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(w) = <span class="self">self</span>.rendering_wait {
out.push((<span class="string">"rendering_wait"</span>.into(), w.to_string()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(s) = <span class="kw-2">&</span><span class="self">self</span>.wait_for_selector {
out.push((<span class="string">"wait_for_selector"</span>.into(), s.clone()));
}
<span class="kw">if </span><span class="self">self</span>.auto_scroll {
out.push((<span class="string">"auto_scroll"</span>.into(), <span class="string">"true"</span>.into()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(js) = <span class="kw-2">&</span><span class="self">self</span>.js {
out.push((<span class="string">"js"</span>.into(), url_safe_b64_encode(js)));
}
<span class="kw">if </span>!<span class="self">self</span>.options.is_empty() {
<span class="kw">let </span>joined = <span class="self">self
</span>.options
.iter()
.map(|o| o.as_str())
.collect::<Vec<<span class="kw">_</span>>>()
.join(<span class="string">","</span>);
out.push((<span class="string">"options"</span>.into(), joined));
}
<span class="kw">if </span><span class="self">self</span>.cache {
out.push((<span class="string">"cache"</span>.into(), <span class="string">"true"</span>.into()));
<span class="kw">if let </span><span class="prelude-val">Some</span>(ttl) = <span class="self">self</span>.cache_ttl {
out.push((<span class="string">"cache_ttl"</span>.into(), ttl.to_string()));
}
<span class="kw">if </span><span class="self">self</span>.cache_clear {
out.push((<span class="string">"cache_clear"</span>.into(), <span class="string">"true"</span>.into()));
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(wh) = <span class="kw-2">&</span><span class="self">self</span>.webhook {
out.push((<span class="string">"webhook_name"</span>.into(), wh.clone()));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(vd) = <span class="self">self</span>.vision_deficiency {
out.push((<span class="string">"vision_deficiency"</span>.into(), vd.as_str().into()));
}
<span class="prelude-val">Ok</span>(out)
}
}
<span class="doccomment">/// Builder for [`ScreenshotConfig`].
</span><span class="attr">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>ScreenshotConfigBuilder {
cfg: ScreenshotConfig,
}
<span class="kw">impl </span>ScreenshotConfigBuilder {
<span class="doccomment">/// Set output format.
</span><span class="kw">pub fn </span>format(<span class="kw-2">mut </span><span class="self">self</span>, f: ScreenshotFormat) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.format = <span class="prelude-val">Some</span>(f);
<span class="self">self
</span>}
<span class="doccomment">/// Set capture target.
</span><span class="kw">pub fn </span>capture(<span class="kw-2">mut </span><span class="self">self</span>, c: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.capture = <span class="prelude-val">Some</span>(c.into());
<span class="self">self
</span>}
<span class="doccomment">/// Set viewport resolution.
</span><span class="kw">pub fn </span>resolution(<span class="kw-2">mut </span><span class="self">self</span>, r: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.resolution = <span class="prelude-val">Some</span>(r.into());
<span class="self">self
</span>}
<span class="doccomment">/// Set proxy country.
</span><span class="kw">pub fn </span>country(<span class="kw-2">mut </span><span class="self">self</span>, c: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.country = <span class="prelude-val">Some</span>(c.into());
<span class="self">self
</span>}
<span class="doccomment">/// Set timeout (ms).
</span><span class="kw">pub fn </span>timeout(<span class="kw-2">mut </span><span class="self">self</span>, t: u32) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.timeout = <span class="prelude-val">Some</span>(t);
<span class="self">self
</span>}
<span class="doccomment">/// Set rendering wait (ms).
</span><span class="kw">pub fn </span>rendering_wait(<span class="kw-2">mut </span><span class="self">self</span>, t: u32) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.rendering_wait = <span class="prelude-val">Some</span>(t);
<span class="self">self
</span>}
<span class="doccomment">/// Set wait-for-selector.
</span><span class="kw">pub fn </span>wait_for_selector(<span class="kw-2">mut </span><span class="self">self</span>, s: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.wait_for_selector = <span class="prelude-val">Some</span>(s.into());
<span class="self">self
</span>}
<span class="doccomment">/// Add a capture option.
</span><span class="kw">pub fn </span>option(<span class="kw-2">mut </span><span class="self">self</span>, o: ScreenshotOption) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.options.push(o);
<span class="self">self
</span>}
<span class="doccomment">/// Enable auto-scroll.
</span><span class="kw">pub fn </span>auto_scroll(<span class="kw-2">mut </span><span class="self">self</span>, v: bool) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.auto_scroll = v;
<span class="self">self
</span>}
<span class="doccomment">/// Set custom JS.
</span><span class="kw">pub fn </span>js(<span class="kw-2">mut </span><span class="self">self</span>, js: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.js = <span class="prelude-val">Some</span>(js.into());
<span class="self">self
</span>}
<span class="doccomment">/// Enable cache.
</span><span class="kw">pub fn </span>cache(<span class="kw-2">mut </span><span class="self">self</span>, v: bool) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.cache = v;
<span class="self">self
</span>}
<span class="doccomment">/// Set cache TTL.
</span><span class="kw">pub fn </span>cache_ttl(<span class="kw-2">mut </span><span class="self">self</span>, v: u32) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.cache_ttl = <span class="prelude-val">Some</span>(v);
<span class="self">self
</span>}
<span class="doccomment">/// Force cache refresh.
</span><span class="kw">pub fn </span>cache_clear(<span class="kw-2">mut </span><span class="self">self</span>, v: bool) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.cache_clear = v;
<span class="self">self
</span>}
<span class="doccomment">/// Set webhook name.
</span><span class="kw">pub fn </span>webhook(<span class="kw-2">mut </span><span class="self">self</span>, v: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.webhook = <span class="prelude-val">Some</span>(v.into());
<span class="self">self
</span>}
<span class="doccomment">/// Set vision deficiency simulation.
</span><span class="kw">pub fn </span>vision_deficiency(<span class="kw-2">mut </span><span class="self">self</span>, v: VisionDeficiencyType) -> <span class="self">Self </span>{
<span class="self">self</span>.cfg.vision_deficiency = <span class="prelude-val">Some</span>(v);
<span class="self">self
</span>}
<span class="doccomment">/// Finalize the builder.
</span><span class="kw">pub fn </span>build(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><ScreenshotConfig, ScrapflyError> {
<span class="kw">if </span><span class="self">self</span>.cfg.url.is_empty() {
<span class="kw">return </span><span class="prelude-val">Err</span>(ScrapflyError::Config(<span class="string">"url is required"</span>.into()));
}
<span class="prelude-val">Ok</span>(<span class="self">self</span>.cfg)
}
}
</code></pre></div></section></main></body></html>