Struct PubMedId 

pub struct PubMedId { /* private fields */ }

A validated PubMed ID (PMID)

PMIDs are numeric identifiers for articles in the PubMed database. This type ensures that the ID is valid and provides methods for parsing, cleaning, and converting between different representations.

Examples

use pubmed_parser::common::PubMedId;

// Parse from string
let pmid = PubMedId::parse("31978945").unwrap();
assert_eq!(pmid.as_u32(), 31978945);
assert_eq!(pmid.as_str(), "31978945");

// Parse with whitespace (automatically cleaned)
let pmid = PubMedId::parse("  31978945  ").unwrap();
assert_eq!(pmid.as_u32(), 31978945);

// From u32
let pmid = PubMedId::from_u32(31978945);
assert_eq!(pmid.to_string(), "31978945");

Implementations

impl PubMedId

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

Parse a PMID from a string

The input is automatically trimmed of whitespace.

Errors

Returns ParseError::InvalidPmid if:

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

Examples

use pubmed_parser::common::PubMedId;

let pmid = PubMedId::parse("31978945").unwrap();
assert_eq!(pmid.as_u32(), 31978945);

// With whitespace
let pmid = PubMedId::parse("  31978945  ").unwrap();
assert_eq!(pmid.as_u32(), 31978945);

// Invalid cases
assert!(PubMedId::parse("").is_err());
assert!(PubMedId::parse("abc").is_err());
assert!(PubMedId::parse("0").is_err());
assert!(PubMedId::parse("-123").is_err());

pub fn from_u32(value: u32) -> PubMedId

Create a PubMedId from a u32 value

Panics

Panics if the value is zero.

Examples

use pubmed_parser::common::PubMedId;

let pmid = PubMedId::from_u32(31978945);
assert_eq!(pmid.as_u32(), 31978945);

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

Try to create a PubMedId from a u32 value

Errors

Returns ParseError::InvalidPmid if the value is zero.

Examples

use pubmed_parser::common::PubMedId;

let pmid = PubMedId::try_from_u32(31978945).unwrap();
assert_eq!(pmid.as_u32(), 31978945);

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

pub fn as_u32(&self) -> u32

Get the PMID as a u32

Examples

use pubmed_parser::common::PubMedId;

let pmid = PubMedId::parse("31978945").unwrap();
assert_eq!(pmid.as_u32(), 31978945);

pub fn as_str(&self) -> String

Get the PMID as a string slice

Note: This creates a temporary String and returns it. For owned String, use to_string().

Examples

use pubmed_parser::common::PubMedId;

let pmid = PubMedId::from_u32(31978945);
assert_eq!(pmid.as_str(), "31978945");

Trait Implementations

impl Clone for PubMedId

fn clone(&self) -> PubMedId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PubMedId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PubMedId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PubMedId

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

Formats the value using the given formatter.

impl From<u32> for PubMedId

fn from(value: u32) -> PubMedId

Converts to this type from the input type.

impl FromStr for PubMedId

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for PubMedId

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 PubMedId

fn eq(&self, other: &PubMedId) -> 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 PubMedId

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 PubMedId

impl StructuralPartialEq for PubMedId