scrapfly-sdk 0.2.1

Async Rust client for the Scrapfly web scraping, screenshot, extraction and crawler APIs
Documentation
<!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/result/scrape.rs`."><title>scrape.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/result/</div>scrape.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></pre></div><pre class="rust"><code><span class="doccomment">//! Scrape result — port of `sdk/go/result_scrape.go`.
//!
//! Only the fields a typical caller cares about are strongly typed; the
//! rest land in `serde_json::Value` to survive API contract drift.

</span><span class="kw">use </span>std::collections::BTreeMap;

<span class="kw">use </span>serde::Deserialize;

<span class="doccomment">/// Response envelope from `POST /scrape`.
</span><span class="attr">#[derive(Debug, Clone, Deserialize)]
</span><span class="kw">pub struct </span>ScrapeResult {
    <span class="doccomment">/// UUID of the scrape.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>uuid: String,
    <span class="doccomment">/// Echo of the config the server used.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>config: serde_json::Value,
    <span class="doccomment">/// Execution context (cost, proxy, cache…).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>context: serde_json::Value,
    <span class="doccomment">/// Result data.
    </span><span class="kw">pub </span>result: ResultData,
}

<span class="doccomment">/// Body of the `result` field.
</span><span class="attr">#[derive(Debug, Clone, Deserialize, Default)]
</span><span class="kw">pub struct </span>ResultData {
    <span class="doccomment">/// Scraped content (HTML, text, markdown…).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>content: String,
    <span class="doccomment">/// Content encoding.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>content_encoding: String,
    <span class="doccomment">/// Content type.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>content_type: String,
    <span class="doccomment">/// Final URL.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>url: String,
    <span class="doccomment">/// HTTP status code from the target.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>status_code: u16,
    <span class="doccomment">/// Status string (`DONE`, etc.).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>status: String,
    <span class="doccomment">/// Scrape success marker.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>success: bool,
    <span class="doccomment">/// Scrape duration (seconds).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>duration: f64,
    <span class="doccomment">/// Format marker (`raw`, `text`, `clob`, `blob`…).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>format: String,
    <span class="doccomment">/// Error envelope for server-side scrape failures.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>error: <span class="prelude-ty">Option</span>&lt;ScrapeErrorDetails&gt;,
    <span class="doccomment">/// Log URL for the dashboard.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>log_url: String,
    <span class="doccomment">/// Response headers.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>response_headers: serde_json::Value,
    <span class="doccomment">/// Request headers.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>request_headers: BTreeMap&lt;String, String&gt;,
    <span class="doccomment">/// Screenshots captured during this scrape.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>screenshots: BTreeMap&lt;String, serde_json::Value&gt;,
    <span class="doccomment">/// Extracted data (if any).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>extracted_data: <span class="prelude-ty">Option</span>&lt;serde_json::Value&gt;,
    <span class="doccomment">/// Browser data (local/session storage, attachments…).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>browser_data: serde_json::Value,
    <span class="doccomment">/// Iframes discovered during a rendered scrape. Each entry has at least
    /// a `url` field pointing at the embedded document. Stored as
    /// `serde_json::Value` because the exact shape varies with the engine
    /// version (url, url_discovered_as, navigation_id, …).
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>iframes: serde_json::Value,
}

<span class="doccomment">/// Inner error details.
</span><span class="attr">#[derive(Debug, Clone, Deserialize, Default)]
</span><span class="kw">pub struct </span>ScrapeErrorDetails {
    <span class="doccomment">/// Error code.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>code: String,
    <span class="doccomment">/// HTTP code.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>http_code: u16,
    <span class="doccomment">/// Error message.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>message: String,
    <span class="doccomment">/// Documentation URL.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>doc_url: String,
    <span class="doccomment">/// Retryable flag.
    </span><span class="attr">#[serde(default)]
    </span><span class="kw">pub </span>retryable: bool,
}
</code></pre></div></section></main></body></html>