releasekit 0.1.0

Client-agnostic library for fetching releases from git forges
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

//! Data model for releases and assets.

/// A release from a git forge.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Release {
    pub(crate) name: Option<String>,
    pub(crate) tag: String,
    pub(crate) prerelease: bool,
    pub(crate) published_at: String,
    pub(crate) body: Option<String>,
    pub(crate) assets: Vec<Asset>,
}

impl Release {
    /// The release name, if set.
    pub fn name(&self) -> Option<&str> {
        self.name.as_deref()
    }

    /// The git tag this release points to.
    pub fn tag(&self) -> &str {
        &self.tag
    }

    /// Whether this is a prerelease.
    pub fn is_prerelease(&self) -> bool {
        self.prerelease
    }

    /// The ISO 8601 timestamp when the release was published.
    pub fn published_at(&self) -> &str {
        &self.published_at
    }

    /// The release body / description, if set.
    pub fn body(&self) -> Option<&str> {
        self.body.as_deref()
    }

    /// The assets attached to this release.
    pub fn assets(&self) -> &[Asset] {
        &self.assets
    }
}

/// A downloadable asset attached to a release.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Asset {
    pub(crate) name: String,
    pub(crate) size: Option<u64>,
    pub(crate) url: String,
}

impl Asset {
    /// The asset filename.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// The asset size in bytes, if reported by the forge.
    pub fn size(&self) -> Option<u64> {
        self.size
    }

    /// The download URL for this asset.
    pub fn url(&self) -> &str {
        &self.url
    }
}