human_name 2.0.4

A library for parsing and comparing human names
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

use super::Name;
use serde::{Serialize, Serializer};
use std::borrow::Cow;

#[derive(Serialize)]
struct PrettyNameParts<'a> {
    first_initial: char,
    surname: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    given_name: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    middle_initials: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    middle_names: Option<Cow<'a, str>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    generational_suffix: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    honorific_prefix: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    honorific_suffix: Option<&'a str>,
}

impl Name {
    fn to_pretty_parts(&self) -> PrettyNameParts {
        PrettyNameParts {
            first_initial: self.first_initial(),
            surname: self.surname(),
            given_name: self.given_name(),
            middle_initials: self.middle_initials(),
            middle_names: self.middle_name(),
            generational_suffix: self.generational_suffix(),
            honorific_prefix: self.honorific_prefix(),
            honorific_suffix: self.honorific_suffix(),
        }
    }
}

impl Serialize for Name {
    /// Serializes a name into parsed components.
    ///
    /// ```
    /// use human_name::Name;
    ///
    /// let name = Name::parse("DR JOHN ALLEN Q MACDONALD JR").unwrap();
    /// assert_eq!(
    ///   r#"{"first_initial":"J","surname":"MacDonald","given_name":"John","middle_initials":"AQ","middle_names":"Allen","generational_suffix":"Jr.","honorific_prefix":"Dr."}"#,
    ///   serde_json::to_string(&name).unwrap()
    /// );
    /// ```
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        self.to_pretty_parts().serialize(serializer)
    }
}