Struct ARK 

pub struct ARK {
    pub assigned_name: Option<String>,
    pub label: String,
    pub name_assigning_authority_number: Option<String>,
    pub name_mapping_authority: Option<String>,
    pub parts: Vec<String>,
    pub variants: Vec<String>,
}

Archival Resource Key (ARK)

Notes

• ARKs are the only mainstream, non-siloed, non-paywalled identifiers that you can register to use in about 48 hours
• ARKs are decentralized
• There are no fees for ARKs, PURLs, and URNs
• ARKs give access to almost any kind of thing, whether digital, physical, abstract, person, group, etc.
• ARKs can be deleted
• ARKs support early object development
• ARKs that differ only by hyphens are considered identical

See the ARK specification and https://wiki.lyrasis.org/display/ARKs/ARK+Identifiers+FAQ for more information

Fields

assigned_name: Option<String>

The part of the ARK string that your organization is responsible for making unique.

The first 2 or more characters constitue the shoulder of the ARK which must meet the following criteria:

• Must start with one or more lowercase letters
• Must end with a digit (non-zero preferred)
• Must not contain vowels or the letter “l” (ell)
• Must not contain any / characters (being opaque is part of the shoulder design)

label: String

Prefix for NAAN (e.g., “ark:” or the older, “ark:/”)

Label is mandatory

name_assigning_authority_number: Option<String>

Number (here represented as a string) identifying an organization that creates or assigns identifiers

Notes

• Since 2001, every assigned name assigning authority number (NAAN) has consisted of exactly five digits, specifically five beta-numeric digits
• Any given identifier will have exactly one NAAN but may have more than one NMA (at a time or over time)
• Similar to registration authority or prefix for DOIs, naming authority for Handles, and namespace identifier for URNs

name_mapping_authority: Option<String>

String identifying a service that accepts names and returns information about them

Notes

Any given identifier will have exactly one NAAN but may have more than one NMA (at a time or over time)

parts: Vec<String>

First section of optional “qualifier” part of ARK

Generally serve as sub-namespaces to enabling grouping ARKs

variants: Vec<String>

Last section of optional “qualifier” part of ARK

Typically is used to identify a specific version of a resource (i.e., “pdf”, “fr”, “v3”, etc.)

Implementations

impl ARK

pub fn init() -> ARKBuilder

Create an instance of ARK using the builder syntax

impl ARK

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

where S: AsRef<str>,

Convenience method for easily parsing and formatting an ARK from a string value

Example

use acorn_lib::schema::pid::ARK;

assert_eq!(ARK::format("ark:/1234/5678"), "ark:/1234/5678");
assert_eq!(ARK::format("https://n2t.net/ark:12148/btv1b8449691v/f29"), "ark:12148/btv1b8449691v/f29");

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

where S: AsRef<str>,

Create new ARK by parsing raw string value

Example

use acorn_lib::schema::pid::ARK;

let doi = ARK::from_string("");

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

where S: AsRef<str>,

Check if value is a valid ARK

Conditions

• ARKs are preferred to be “actionable” with the inclusion of a NMA URL, but are not required to be so (NMA is optional)
• If ARK is to contain a URL, “https” is the only allowed scheme
• Should have only one instance of “ark:” label
• NAAN should be an integer
• Assigned name should start with a valid shoulder
• Last character should be valid check digit (see noid_check_digit)

Example

use acorn_lib::schema::pid::ARK;

assert!(ARK::is_valid("https://n2t.net/ark:99166/w66d60p2"));
assert!(ARK::is_valid("https://n2t.net/ark:12148/btv1b8449691v/f29"));

Trait Implementations

impl Clone for ARK

fn clone(&self) -> ARK

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ARK

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

Formats the value using the given formatter.

impl Default for ARK

fn default() -> Self

Returns the “default value” for a type.

impl Display for ARK

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

Format a ARK into a standard format of "{NMA}{label}{NAAN}/{Assigned Name}/{Parts}{Variants}"

impl PersistentIdentifier for ARK

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

Returns consistent string representation of ARK qualifiers which often name subobjects of a persistent object that are less stable and less opaquely named than the parent object

fn new() -> Self

Create a new PID

fn format(&self) -> String

Convert self into a string with a standard format

fn schema_uri(&self) -> String

Get standardized form of schema URI for a PID

fn identifier(&self) -> String

Get PID identifier section

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

Get PID prefix (different interpretation depending on PID type)

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

Get PID check digit (when applicable)

fn is_valid(&self) -> bool

Check if PID is valid