acorn-lib 0.1.70

ACORN library
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
138

//! Provider-neutral schema types for remote metadata discovery.
use core::fmt;
use serde::{Deserialize, Serialize};

/// Normalized entity returned by a remote discovery provider
#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum RemoteEntity {
    /// Research software project
    Project,
    /// Person
    Person,
    /// Organization
    Organization,
    /// Source-code repository
    Repository,
}
/// Provider-neutral relationship between an organization and a discovered entity
#[derive(Clone, Copy, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum RemoteOrganizationRole {
    /// Any credited relationship
    #[default]
    Any,
    /// Submitting site
    SiteOwner,
    /// Research organization
    Research,
    /// Sponsoring organization
    Sponsor,
    /// Contributing organization
    Contributor,
    /// Developing organization
    Developer,
}
/// Provider-neutral aggregated organization search result
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct Organization {
    /// Preferred display name
    pub name: String,
    /// Aliases and site codes
    pub aliases: Vec<String>,
    /// Relationships across matching projects
    pub roles: Vec<String>,
    /// Associated provider-native project identifiers
    pub project_ids: Vec<u64>,
    /// Associated project titles
    pub project_titles: Vec<String>,
}
/// Provider-neutral aggregated person search result.
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct Person {
    /// Display name
    pub name: String,
    /// ORCID identifier
    pub orcid: Option<String>,
    /// Email address
    pub email: Option<String>,
    /// Affiliations across matching projects
    pub affiliations: Vec<String>,
    /// Roles across matching projects
    pub roles: Vec<String>,
    /// Associated provider-native project identifiers
    pub project_ids: Vec<u64>,
    /// Associated project titles
    pub project_titles: Vec<String>,
}
/// An organization credited by a discovered project
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ProjectOrganization {
    /// Organization display name
    #[serde(default)]
    pub organization_name: String,
    /// Whether the source identifies this as a DOE organization
    #[serde(default, rename = "DOE")]
    pub doe: bool,
    /// Primary award number, when supplied for sponsors
    #[serde(default)]
    pub primary_award: Option<String>,
}
/// A person credited by a discovered project
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct ProjectPerson {
    /// Email address.
    #[serde(default)]
    pub email: String,
    /// ORCID identifier.
    #[serde(default)]
    pub orcid: String,
    /// Given name.
    #[serde(default)]
    pub first_name: String,
    /// Family name.
    #[serde(default)]
    pub last_name: String,
    /// Middle name.
    #[serde(default)]
    pub middle_name: String,
    /// Contributor type when this is a contributor entry.
    #[serde(default)]
    pub contributor_type: Option<String>,
    /// Organization affiliations.
    #[serde(default)]
    pub affiliations: Vec<String>,
}
impl ProjectPerson {
    /// Return the person's display name.
    pub fn name(&self) -> String {
        [&self.first_name, &self.middle_name, &self.last_name]
            .into_iter()
            .filter(|part| !part.trim().is_empty())
            .map(|part| part.trim())
            .collect::<Vec<_>>()
            .join(" ")
    }
}
impl fmt::Display for RemoteEntity {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(match self {
            | Self::Project => "project",
            | Self::Person => "person",
            | Self::Organization => "organization",
            | Self::Repository => "repository",
        })
    }
}
impl fmt::Display for RemoteOrganizationRole {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(match self {
            | Self::Any => "any",
            | Self::SiteOwner => "site-owner",
            | Self::Research => "research",
            | Self::Sponsor => "sponsor",
            | Self::Contributor => "contributor",
            | Self::Developer => "developer",
        })
    }
}