citeworks-csl 0.3.0

Serde types for serialising and deserialising CSL-JSON
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

//! Types and utilities for names complex values.

use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};

/// Name complex field type.
///
/// Contains information about one person.
///
/// Should have at least the `family` field (for personyms) or the `literal`
/// field (for institutions). People using mononyms can have _just_ the `family`
/// field as their sole name.
#[derive(Debug, Default, Clone, Hash, Eq, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct Name {
	/// Represents the familial name that a person inherits.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub family: Option<String>,

	/// Represents the name a person has been given or has chosen for themselves.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub given: Option<String>,

	/// Elements before the given name.
	///
	/// For example, in "Rev. Martin Luther Jr.", "Rev." is the dropping
	/// particle.
	///
	/// It's also acceptable to include these particles directly as part of the
	/// `given` field.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub dropping_particle: Option<String>,

	/// Elements before the family name.
	///
	/// For example, in "Bartolomé de las Casas", "de las" are the non-dropping
	/// particles.
	///
	/// It's also acceptable to include these particles directly as part of the
	/// `family` field.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub non_dropping_particle: Option<String>,

	/// Elements after the family name.
	///
	/// For example, in "Rev. Martin Luther Jr.", "Jr." is the suffix.
	///
	/// Multiple suffixes may be given, e.g. "Jr., Ph.D.".
	///
	/// It's also acceptable to include these suffixes directly as part of the
	/// `family` field.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub suffix: Option<String>,

	/// Name of an institution, or whole name of a person.
	#[serde(default, skip_serializing_if = "Option::is_none")]
	pub literal: Option<String>,

	/// Name fields not defined above.
	#[serde(flatten)]
	pub extra: BTreeMap<String, String>,
}