Struct DOI 

pub struct DOI {
    pub schema_uri: Option<String>,
    pub directory_indicator: Option<String>,
    pub registrant_code: Option<String>,
    pub suffix: Option<String>,
}

Digital Object Identifier (DOI)

DOIs consist of a DOI name which is resolved at https://doi.org, with the full URI formulated according to the pattern https://doi.org/{DOI_name}. DOI names in turn consist of a prefix and a suffix, separated by a forward slash. The prefix is a code indicating the registrant who issues the DOI, e.g., Harvard University Dataverse - 10.7910; Dryad Digital Repository - 10.5061. The suffix is the identifier, in any form, assigned by the registrant.¹

See https://www.doi.org/doi-handbook/HTML/index.html for more information

---

1. N. Juty, S. M. Wimalaratne, S. Soiland-Reyes, J. Kunze, C. A. Goble, and T. Clark, "Unique, Persistent, Resolvable: Identifiers as the Foundation of FAIR," Data Intellegence, vol. 2, no. 1-2, pp. 30-39, Jan. 2020, doi: 10.1162/dint_a_00025. ↩

Fields

schema_uri: Option<String>

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

directory_indicator: Option<String>

Directory indicator

Rules

• Can contain only numeric values
• usually 10 but other indicators may be designated as compliant by the DOI Foundation

registrant_code: Option<String>

Registrant code

Rules

• Can contain only numeric values and one or several full stops which are used to subdivide the code
• If the directory indicator is 10 then a registrant code is mandatory

suffix: Option<String>

Suffix

Rules

• Shall be unique to the prefix element that precedes it
• Can be a sequential number
• Can be an identifier generated from or based on another system used by the registrant
• No length limit is set to the suffix by the DOI System

Implementations

impl DOI

pub fn init() -> DOIBuilder

Create an instance of DOI using the builder syntax

impl DOI

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

where S: AsRef<str>,

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

Example

use acorn_lib::schema::pid::DOI;

assert_eq!(DOI::format("https://doi.org/10.1000/182"), "10.1000/182");
assert_eq!(DOI::format("10.1000/182"), "10.1000/182");

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

where S: AsRef<str>,

Create new DOI by parsing raw string value

Example

use acorn_lib::schema::pid::DOI;

let doi = DOI::from_string("https://doi.org/10.1000/182");
assert_eq!(doi.prefix(), "10.1000");
assert_eq!(doi.suffix(), "182");

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

where S: AsRef<str>,

Check if value is a valid DOI

Conditions

• Must match DOI regular expression (see RE_DOI_TEXT)
• Is valid with or without schema URI¹
• 10.5555/ is not a valid DOI prefix

Example

use acorn_lib::schema::pid::DOI;

assert!(DOI::is_valid("https://doi.org/10.1000/182"));
assert!(DOI::is_valid("10.1000/182"));

---

1. Use DOI::format(value) to ensure value is formatted correctly ↩

Trait Implementations

impl Clone for DOI

fn clone(&self) -> DOI

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DOI

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

Formats the value using the given formatter.

impl Default for DOI

fn default() -> Self

Returns the “default value” for a type.

impl Display for DOI

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

Format a DOI into a standard format of "{prefix}/{suffix}"

impl PersistentIdentifier for DOI

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

Get DOI prefix (i.e., “{directory_indicator}.{registrant_code}”)

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

Get DOI suffix

fn new() -> Self

Create a new PID

fn schema_uri(&self) -> String

Get standardized form of schema URI for a PID

fn identifier(&self) -> String

Get PID identifier section

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

Get PID check digit (when applicable)

fn format(&self) -> String

Convert self into a string with a standard format

fn is_valid(&self) -> bool

Check if PID is valid