Skip to main content

CitationConfig

Struct CitationConfig 

Source
pub struct CitationConfig {
    pub title: String,
    pub abstract_: String,
    pub authors: Vec<CitationAuthor>,
    pub message: String,
    pub repository_code: String,
    pub url: Option<String>,
    pub license: Option<String>,
    pub date_released: Option<String>,
    pub doi: Option<String>,
}
Expand description

Configuration for the alef-generated CITATION.cff file at the repo root.

When this section is present in alef.toml, alef sync-versions writes a fully-rendered Citation File Format YAML using these fields plus the current workspace version (read from Cargo.toml). When absent, alef falls back to updating the version: line of a hand-authored CITATION.cff in place.

All field names follow Rust convention; the renderer emits the canonical CFF kebab-case keys (cff-version, repository-code, date-released, family-names, given-names).

Fields§

§title: String

Software title (title:). Required.

§abstract_: String

One-paragraph summary (abstract:). Required.

§authors: Vec<CitationAuthor>

Authors list — at least one entry required. Persons and legal entities can be mixed (e.g. Na'aman Hirschfeld + Kreuzberg, Inc.).

§message: String

Canonical citation message shown to consumers (message:).

§repository_code: String

Source-code repository URL (repository-code:). Required.

§url: Option<String>

Project landing-page URL (url:). Optional.

§license: Option<String>

SPDX license identifier (license:). When omitted, the renderer falls back to Cargo.toml [workspace.package].license.

§date_released: Option<String>

Release date in YYYY-MM-DD form (date-released:). Optional.

§doi: Option<String>

Persistent DOI for the cited release (doi:). Optional.

Trait Implementations§

Source§

impl Clone for CitationConfig

Source§

fn clone(&self) -> CitationConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CitationConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CitationConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CitationConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,