Struct PmcId 

pub struct PmcId { /* private fields */ }

A validated PubMed Central ID (PMC ID)

PMC IDs are identifiers for full-text articles in the PMC database. They consist of the prefix “PMC” followed by numeric digits. This type ensures that the ID is valid and provides methods for parsing, cleaning, and normalizing the ID format.

Examples

use pubmed_parser::common::PmcId;

// Parse with PMC prefix
let pmcid = PmcId::parse("PMC7906746").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");
assert_eq!(pmcid.numeric_part(), 7906746);

// Parse without PMC prefix (automatically added)
let pmcid = PmcId::parse("7906746").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");

// With whitespace (automatically cleaned)
let pmcid = PmcId::parse("  PMC7906746  ").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");

Implementations

impl PmcId

pub fn parse(s: &str) -> Result<PmcId, ParseError>

Parse a PMC ID from a string

The input is automatically trimmed of whitespace and the “PMC” prefix is added if not present. Case-insensitive parsing is supported.

Errors

Returns ParseError::InvalidPmcid if:

• The string is empty after trimming
• The numeric part contains non-numeric characters
• The numeric part is zero
• The number is too large to fit in a u32

Examples

use pubmed_parser::common::PmcId;

// With PMC prefix
let pmcid = PmcId::parse("PMC7906746").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");

// Without PMC prefix
let pmcid = PmcId::parse("7906746").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");

// Case insensitive
let pmcid = PmcId::parse("pmc7906746").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");

// With whitespace
let pmcid = PmcId::parse("  PMC7906746  ").unwrap();
assert_eq!(pmcid.as_str(), "PMC7906746");

// Invalid cases
assert!(PmcId::parse("").is_err());
assert!(PmcId::parse("PMC").is_err());
assert!(PmcId::parse("PMC0").is_err());
assert!(PmcId::parse("PMCabc").is_err());

pub fn from_u32(value: u32) -> PmcId

Create a PmcId from a u32 value

Panics

Panics if the value is zero.

Examples

use pubmed_parser::common::PmcId;

let pmcid = PmcId::from_u32(7906746);
assert_eq!(pmcid.as_str(), "PMC7906746");
assert_eq!(pmcid.numeric_part(), 7906746);

pub fn try_from_u32(value: u32) -> Result<PmcId, ParseError>

Try to create a PmcId from a u32 value

Errors

Returns ParseError::InvalidPmcid if the value is zero.

Examples

use pubmed_parser::common::PmcId;

let pmcid = PmcId::try_from_u32(7906746).unwrap();
assert_eq!(pmcid.numeric_part(), 7906746);

assert!(PmcId::try_from_u32(0).is_err());

pub fn as_str(&self) -> String

Get the full PMC ID as a string (with “PMC” prefix)

Examples

use pubmed_parser::common::PmcId;

let pmcid = PmcId::from_u32(7906746);
assert_eq!(pmcid.as_str(), "PMC7906746");

pub fn numeric_part(&self) -> u32

Get the numeric part of the PMC ID (without “PMC” prefix)

Examples

use pubmed_parser::common::PmcId;

let pmcid = PmcId::parse("PMC7906746").unwrap();
assert_eq!(pmcid.numeric_part(), 7906746);

pub fn numeric_part_str(&self) -> String

Get the numeric part as a string (without “PMC” prefix)

Examples

use pubmed_parser::common::PmcId;

let pmcid = PmcId::parse("PMC7906746").unwrap();
assert_eq!(pmcid.numeric_part_str(), "7906746");

Trait Implementations

impl Clone for PmcId

fn clone(&self) -> PmcId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PmcId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PmcId

fn deserialize<__D>( __deserializer: __D, ) -> Result<PmcId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PmcId

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

Formats the value using the given formatter.

impl From<u32> for PmcId

fn from(value: u32) -> PmcId

Converts to this type from the input type.

impl FromStr for PmcId

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PmcId, ParseError>

Parses a string s to return a value of this type.

impl Hash for PmcId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PmcId

fn eq(&self, other: &PmcId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PmcId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PmcId

impl StructuralPartialEq for PmcId