Struct ORCID 

pub struct ORCID {
    pub schema_uri: Option<String>,
    pub identifier: Option<String>,
    pub check_digit: Option<String>,
}

Open Researcher and Contributor ID (ORCiD)¹

Disambiguates researchers, and connects people with their research activities. This includes employment affiliations, research outputs, funding, peer review activity, research resources, society membership, distinctions and other scholarly infrastructure.

See https://orcid.org/ for more information

---

1. L. L. Haak, M. Fenner, L. Paglione, E. Pentz, and H. Ratner, "ORCID: a system to uniquely identify researchers," Learned Publishing, vol. 25, no. 4, pp. 259-264, 2012, doi: 10.1087/20120404. ↩

Fields

schema_uri: Option<String>

Schema URI (i.e., https://orcid.org/)

identifier: Option<String>

16 digit string with hyphens every 4 digits (for readability)

This value can be stored with or without hyphens. To ensure compliancy, use ORCID::identifier method to access ORCiD identifier.

check_digit: Option<String>

The check digit is the last (16th) digit of the identifier

Note

Check digit should be verified IAW by ISO 7064, MOD 11-2 (see iso7064_check_digit)

Implementations

impl ORCID

pub fn init() -> ORCIDBuilder

Create an instance of ORCID using the builder syntax

impl ORCID

pub fn format<S>(value: S) -> String

where S: AsRef<str>,

Convenience method for easily parsing and formatting a ORCID from a string value

Example

use acorn_lib::schema::pid::ORCID;

assert_eq!(ORCID::format("https://orcid.org/0000-0002-2057-9115"), "https://orcid.org/0000-0002-2057-9115");
assert_eq!(ORCID::format("0000-0002-2057-9115"), "https://orcid.org/0000-0002-2057-9115");

pub fn from_string<S>(value: S) -> ORCID

where S: AsRef<str>,

Create new ORCID by parsing raw string value

Example

use acorn_lib::schema::pid::ORCID;

let orcid = ORCID::from_string("https://orcid.org/0000-0002-2057-9115");
assert_eq!(orcid.identifier(), "0000-0002-2057-9115");

pub fn is_valid<S>(value: S) -> bool

where S: AsRef<str>,

Check if value is a valid ORCiD

Conditions

• ORCiD identifier must be 16 characters, 0 thru 9, or “X”
• Last character of identifier must be a valid ISO 7064 check digit (see iso7064_check_digit)
• Value can be valid with or without hyphens in the ORCiD identifier¹
• Value can be valid with or without schema URI¹

Example

use acorn_lib::schema::pid::ORCID;

assert!(ORCID::is_valid("https://orcid.org/0000-0002-2057-9115"));
assert!(ORCID::is_valid("0000-0002-2057-9115"));
assert!(ORCID::is_valid("0000000220579115"));

---

1. Use ORCID::format(value) to ensure value is formatted correctly ↩ ^1 2

Trait Implementations

impl Clone for ORCID

fn clone(&self) -> ORCID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ORCID

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

Formats the value using the given formatter.

impl Default for ORCID

fn default() -> Self

Returns the “default value” for a type.

impl Display for ORCID

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

Format a ORCiD into a standard format of "{schema_uri}{identifier}"

impl PersistentIdentifier for ORCID

fn schema_uri(&self) -> String

Get ORCID schema URI

Notes

• Should always be “https://orcid.org/”

fn identifier(&self) -> String

Get ORCID identifier

Notes

• Will return an empty string if no identifier is present
• Will always return a 19 character string with a hyphen every 4 characters (i.e., “0000-0000-0000-0000”)

fn new() -> Self

Create a new PID

fn suffix(&self) -> Option<String>

Get PID suffix (different interpretation depending on PID type)

fn check_digit(&self) -> Option<char>

Get PID check digit (when applicable)

fn prefix(&self) -> Option<String>

Get PID prefix (different interpretation depending on PID type)

fn format(&self) -> String

Convert self into a string with a standard format

fn is_valid(&self) -> bool

Check if PID is valid