octocrab 0.54.2

A modern, extensible GitHub API client.
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use serde::{Deserialize, Serialize};
use url::Url;

use super::{MinimalRepository, SimpleUser};
pub use super::{PackageId, PackageVersionId};

/// A package managed by GitHub Packages.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Package {
    pub id: PackageId,
    pub name: String,
    pub package_type: PackageType,
    pub url: Url,
    pub html_url: Url,
    pub version_count: usize,
    pub visibility: PackageVisibility,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub owner: Option<SimpleUser>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repository: Option<MinimalRepository>,
    pub created_at: chrono::DateTime<chrono::Utc>,
    pub updated_at: chrono::DateTime<chrono::Utc>,
}

/// A specific version of a GitHub Package.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct PackageVersion {
    pub id: PackageVersionId,
    pub name: String,
    pub url: Url,
    pub package_html_url: Url,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub html_url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub license: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    pub created_at: chrono::DateTime<chrono::Utc>,
    pub updated_at: chrono::DateTime<chrono::Utc>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deleted_at: Option<chrono::DateTime<chrono::Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub metadata: Option<PackageVersionMetadata>,
}

/// Metadata for a package version.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct PackageVersionMetadata {
    pub package_type: PackageType,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub container: Option<ContainerMetadata>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub docker: Option<DockerMetadata>,
}

/// Container-specific metadata for a package version.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ContainerMetadata {
    #[serde(default)]
    pub tags: Vec<String>,
}

/// Docker-specific metadata for a package version.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct DockerMetadata {
    #[serde(default)]
    pub tag: Vec<String>,
}

/// The type of supported GitHub package.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum PackageType {
    Npm,
    Maven,
    Rubygems,
    Docker,
    Nuget,
    Container,
}

impl std::fmt::Display for PackageType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            PackageType::Npm => write!(f, "npm"),
            PackageType::Maven => write!(f, "maven"),
            PackageType::Rubygems => write!(f, "rubygems"),
            PackageType::Docker => write!(f, "docker"),
            PackageType::Nuget => write!(f, "nuget"),
            PackageType::Container => write!(f, "container"),
        }
    }
}

/// The visibility of a package.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum PackageVisibility {
    Public,
    Private,
    Internal,
}

impl std::fmt::Display for PackageVisibility {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            PackageVisibility::Public => write!(f, "public"),
            PackageVisibility::Private => write!(f, "private"),
            PackageVisibility::Internal => write!(f, "internal"),
        }
    }
}

/// The state of a package version (active or deleted).
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
#[non_exhaustive]
pub enum PackageVersionState {
    Active,
    Deleted,
}

impl std::fmt::Display for PackageVersionState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            PackageVersionState::Active => write!(f, "active"),
            PackageVersionState::Deleted => write!(f, "deleted"),
        }
    }
}