mle 0.28.0

The markup link extractor (mle) extracts links from markup files (Markdown and HTML).
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

// SPDX-FileCopyrightText: 2022 - 2026 Robin Vobruba <hoijui.quaero@gmail.com>
// SPDX-FileCopyrightText: 2020 Armin Becher <becherarmin@gmail.com>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

use std::collections::HashMap;

use async_std::io;

use crate::{anchor::Anchor, config::Tool as Config};

/// If a URL is not stored in the map (the URL does not appear as a key),
/// it means that URL has not yet been checked.
///
/// If the Result is Err, it means the URL has been checked,
/// but was not available, or anchor parsing has failed.
/// If the Option is None, it means the URL was checked and evaluated as for available,
/// but no parsing of anchors was tried.
/// If the Vec is empty, it means that the document was parsed, but no anchors were found.
pub type AnchorTargets = Option<Vec<Anchor>>;

/// If a URL is not stored in the map (the URL does not appear as a key),
/// it means that URL has not yet been checked.
///
/// If the Result is Err, it means the URL has been checked,
/// but was not available, or anchor parsing has failed.
/// If the Option is None, it means the URL was checked and evaluated as for available,
/// but no parsing of anchors was tried.
/// If the Vec is empty, it means that the document was parsed, but no anchors were found.
pub type RemoteCache = HashMap<url::Url, io::Result<AnchorTargets>>;

#[derive(Default, Debug)]
pub struct State {
    pub config: Config,
    pub remote_cache: RemoteCache,
}

impl State {
    #[must_use]
    pub fn new(config: Config) -> Self {
        Self {
            config,
            remote_cache: RemoteCache::new(),
        }
    }
}