pullcaps 0.2.0

An asynchronous client for the PushShift API
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

use chrono::serde::ts_seconds_option;
use chrono::{DateTime, Utc};
use serde::Serialize;

/// Used to filter a particular query down in some way.
#[derive(Clone, Default, Serialize)]
pub struct Filter {
    pub author: Option<String>,
    pub subreddit: Option<String>,

    #[serde(with = "ts_seconds_option")]
    pub before: Option<DateTime<Utc>>,

    #[serde(with = "ts_seconds_option")]
    pub after: Option<DateTime<Utc>>,

    pub sort_type: SortType,

    #[serde(skip)]
    pub limit: Option<i64>,
}

impl Filter {
    pub fn new() -> Self {
        Self {
            author: None,
            subreddit: None,
            before: None,
            after: None,
            sort_type: SortType::default(),
            limit: None,
        }
    }

    #[must_use]
    pub fn author<S: Into<String>>(mut self, author: S) -> Self {
        self.author = Some(author.into());
        self
    }

    #[must_use]
    pub fn subreddit<S: Into<String>>(mut self, subreddit: S) -> Self {
        self.subreddit = Some(subreddit.into());
        self
    }

    #[must_use]
    pub fn before(mut self, before: DateTime<Utc>) -> Self {
        self.before = Some(before);
        self
    }

    #[must_use]
    pub fn after(mut self, after: DateTime<Utc>) -> Self {
        self.after = Some(after);
        self
    }

    #[must_use]
    pub fn sort_type(mut self, sort_type: SortType) -> Self {
        self.sort_type = sort_type;
        self
    }

    #[must_use]
    pub fn limit(mut self, limit: i64) -> Self {
        self.limit = Some(limit);
        self
    }
}

/// Indicates how a particular query should be sorted.
#[non_exhaustive]
#[derive(Clone, Debug, Serialize)]
pub enum SortType {
    /// Sort by creation date.
    #[serde(rename = "created_utc")]
    CreatedDate,
    /// Sort by score.
    #[serde(rename = "score")]
    Score,
    /// Sort by number of comments.
    #[serde(rename = "num_comments")]
    NumComments,
}

impl SortType {
    pub fn new() -> Self {
        Self::CreatedDate
    }
}

impl Default for SortType {
    fn default() -> Self {
        Self::new()
    }
}