robotparser-fork 0.11.0

robots.txt parser for Rust
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

use crate::model::clean_params::CleanParams;
use crate::model::group::Group;
use url::{Origin, Url};

#[derive(Debug, Clone)]
/// The robots.txt model that was obtained after parsing the text of the robots.txt file.
/// To work with this model you should use the trait `robotparser::service::RobotsTxtService`.
/// To create this structure you should use the `robotparser::parser::parse_robots_txt`.
pub struct RobotsTxt {
    origin: Origin,
    groups: Vec<Group>,
    sitemaps: Vec<Url>,
    clean_params: Vec<CleanParams>,
}

impl RobotsTxt {
    pub(crate) fn new(origin: Origin) -> RobotsTxt {
        RobotsTxt {
            origin,
            groups: Vec::new(),
            sitemaps: Vec::new(),
            clean_params: Vec::new(),
        }
    }

    pub(crate) fn add_sitemap(&mut self, url: Url) {
        self.sitemaps.push(url);
    }

    pub(crate) fn get_sitemaps_slice(&self) -> &[Url] {
        self.sitemaps.as_slice()
    }

    pub(crate) fn add_clean_params(&mut self, clean_params: CleanParams) {
        self.clean_params.push(clean_params);
    }

    pub(crate) fn get_clean_params(&self) -> &[CleanParams] {
        self.clean_params.as_slice()
    }

    pub(crate) fn add_group(&mut self, group: Group) {
        self.groups.push(group);
    }

    pub(crate) fn get_origin(&self) -> &Origin {
        &self.origin
    }

    pub(crate) fn find_in_group<'a, T>(
        &'a self,
        user_agent: &str,
        callback: impl Fn(&'a Group) -> Option<T>,
    ) -> Option<T> {
        // Search by user agents
        for group in self.groups.iter() {
            if group.applies_to(user_agent) {
                if let Some(output) = (callback)(group) {
                    return Some(output);
                }
            }
        }
        if let Some(group) = self.get_default_group() {
            if let Some(output) = (callback)(group) {
                return Some(output);
            }
        }
        None
    }

    pub(crate) fn get_default_group(&self) -> Option<&Group> {
        for group in self.groups.iter() {
            if group.is_default() {
                return Some(group);
            }
        }
        None
    }
}