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

use crate::document::RetrievedDocument;

#[cfg(feature = "http_client")]
pub mod cached_client;

/// Fetch a document, given a `resource` description.
pub trait RustReleasesClient {
    /// The type of error returned by the client implementation.
    type Error;

    /// Fetch the document described by the `resource` file.
    fn fetch(&self, resource: ResourceFile) -> Result<RetrievedDocument, Self::Error>;
}

/// A resource which can be fetched, named and stored.
#[derive(Clone, Debug)]
pub struct ResourceFile<'url, 'name> {
    // Where the remote resource is located.
    url: &'url str,
    /// What the resource is to be named.
    name: &'name str,
}

impl<'url, 'name> ResourceFile<'url, 'name> {
    /// Create a new resource file.
    ///
    /// The `url` should point to the file to be fetched.
    /// The `name` should refer to name of this resource. It is recommended that
    /// each separate resource has a unique name.
    pub fn new(url: &'url str, name: &'name str) -> Self {
        Self { url, name }
    }

    /// The `url` points to the file to be fetched.
    pub fn url(&self) -> &'url str {
        self.url
    }

    /// The `name` is the identifier of this resource and is recommended to
    /// be unique per resource.
    pub fn name(&self) -> &'name str {
        self.name
    }
}