duckduckgo-core 0.1.6

DuckDuckGo search client library for duckduckgo-cli
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use std::path::PathBuf;
use std::sync::Arc;

use super::execute;
use super::options::ClientOptions;
use super::types::{SearchResponse, TimeFilter};
use crate::Clock;
use crate::Result;
use crate::rate_limit::Limits;
use crate::rate_limit::ProgressHook;
use crate::region::Region;

#[derive(Clone, Debug)]
pub struct Client {
    options: ClientOptions,
}

#[derive(Clone, Debug)]
pub struct ClientBuilder {
    options: ClientOptions,
}

#[derive(Clone, Debug)]
pub struct SearchBuilder {
    pub(crate) options: ClientOptions,
    pub(crate) query: String,
    pub(crate) page: usize,
    pub(crate) time: Option<TimeFilter>,
    pub(crate) sites: Vec<String>,
}

impl Client {
    #[must_use]
    pub fn builder() -> ClientBuilder {
        ClientBuilder {
            options: ClientOptions::default(),
        }
    }

    #[must_use]
    pub fn search(&self, query: impl Into<String>) -> SearchBuilder {
        SearchBuilder {
            options: self.options.clone(),
            query: query.into(),
            page: 1,
            time: None,
            sites: Vec::new(),
        }
    }
}

impl ClientBuilder {
    pub fn region(mut self, region: Region) -> Self {
        self.options.region = region;
        self
    }
    pub fn num(mut self, num: usize) -> Self {
        self.options.num = num;
        self
    }
    pub fn safe(mut self, safe: bool) -> Self {
        self.options.safe = safe;
        self
    }
    pub fn timeout(mut self, seconds: u64) -> Self {
        self.options.timeout = seconds;
        self
    }
    pub fn proxy(mut self, proxy: Option<String>) -> Self {
        self.options.proxy = proxy;
        self
    }
    pub fn user_agent(mut self, value: Option<String>) -> Self {
        self.options.user_agent = value;
        self
    }
    pub fn retry(mut self, retry: u8) -> Self {
        self.options.retry = retry;
        self
    }
    pub fn no_wait(mut self, value: bool) -> Self {
        self.options.no_wait = value;
        self
    }
    pub fn no_rate_limit(mut self, value: bool) -> Self {
        self.options.no_rate_limit = value;
        self
    }
    pub fn state_dir(mut self, value: PathBuf) -> Self {
        self.options.state_dir = value;
        self
    }
    pub fn endpoint(mut self, value: String) -> Self {
        self.options.endpoint = value;
        self
    }
    pub fn limits(mut self, value: Limits) -> Self {
        self.options.limits = value;
        self
    }
    pub fn clock(mut self, value: Arc<dyn Clock>) -> Self {
        self.options.clock = value;
        self
    }
    /// Install a callback that fires before every cooldown / spacing
    /// sleep cycle. Used by the CLI to emit `[INFO] rate-limit ...`
    /// progress lines on stderr; library callers typically leave this
    /// unset.
    #[must_use]
    pub fn on_rate_limit_progress(mut self, hook: ProgressHook) -> Self {
        self.options.progress_hook = Some(hook);
        self
    }
    pub fn build(self) -> Result<Client> {
        Ok(Client {
            options: self.options,
        })
    }
}

impl SearchBuilder {
    #[must_use]
    pub fn page(mut self, page: usize) -> Self {
        self.page = page;
        self
    }
    #[must_use]
    pub fn time(mut self, time: Option<TimeFilter>) -> Self {
        self.time = time;
        self
    }
    #[must_use]
    pub fn site(mut self, site: String) -> Self {
        self.sites.push(site);
        self
    }
    pub async fn send(self) -> Result<SearchResponse> {
        execute::execute(self).await
    }
}