alef 0.82.1

Opinionated polyglot binding generator for Rust libraries
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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// A person or legal-entity author in a generated `CITATION.cff`. ~keep
#[derive(Debug, Clone, Serialize, Deserialize, Default, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct CitationAuthor {
    /// Person author: family name(s). ~keep
    #[serde(default, alias = "family-names")]
    pub family_names: Option<String>,
    /// Person author: given name(s). ~keep
    #[serde(default, alias = "given-names")]
    pub given_names: Option<String>,
    /// Entity author: organisation or legal-entity name. ~keep
    #[serde(default)]
    pub name: Option<String>,
    /// Optional contact email. ~keep
    #[serde(default)]
    pub email: Option<String>,
    /// Optional ORCID iD URL. ~keep
    #[serde(default)]
    pub orcid: Option<String>,
}

/// Configuration for the Alef-generated `CITATION.cff` file. ~keep
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct CitationConfig {
    /// Software title. ~keep
    pub title: String,
    /// One-paragraph software summary. ~keep
    #[serde(rename = "abstract")]
    pub abstract_: String,
    /// Person and legal-entity authors. ~keep
    pub authors: Vec<CitationAuthor>,
    /// Canonical citation message shown to consumers. ~keep
    #[serde(default = "default_citation_message")]
    pub message: String,
    /// Source-code repository URL. ~keep
    #[serde(rename = "repository-code", alias = "repository_code")]
    pub repository_code: String,
    /// Project landing-page URL. ~keep
    #[serde(default)]
    pub url: Option<String>,
    /// SPDX license identifier. ~keep
    #[serde(default)]
    pub license: Option<String>,
    /// Optional release date in `YYYY-MM-DD` form. ~keep
    #[serde(default, rename = "date-released", alias = "date_released")]
    pub date_released: Option<String>,
    /// Persistent DOI for the cited release. ~keep
    #[serde(default)]
    pub doi: Option<String>,
}

fn default_citation_message() -> String {
    "If you use this software, please cite it using the metadata below.".to_string()
}