Struct UpcA 

pub struct UpcA(/* private fields */);

Universal Product Code version A (UPC-A)

A UPC-A code uniquely identifies a product using a 12-digit number. The last digit is a check digit.

Examples

use upc_a::UpcA;

// Parse an ISRC from a string
let upc_a = UpcA::from_code(123456789012)?;

// Retrieve the numeric value
assert_eq!(upc_a.to_code(), 123456789012);

// Display a formatted ISRC
assert_eq!(upc_a.to_string(), "123456789012");

References

• https://en.wikipedia.org/wiki/Universal_Product_Code
• https://www.gtin.info/upc/

Implementations

impl UpcA

pub const fn from_code(n: u64) -> Result<Self, UpcAParseError>

Creates an UpcA from a numeric code.

The input must be a 12-digit number, and the last digit must be a valid checksum digit.

Examples

use upc_a::UpcA;

// Valid UPC-A
let upc_a = UpcA::from_code(123456789012)?;
assert_eq!(upc_a.to_string(), "123456789012");

// Invalid UPC-A (incorrect checksum)
assert!(UpcA::from_code(123456789010).is_err());

Errors

Returns an UpcAParseError if:

• The integer value exceeds the maximum allowed value (999,999,999,999)
• The checksum digit is invalid

pub const fn to_code(self) -> u64

Returns the decimal integer value of a UpcA.

Examples

use upc_a::UpcA;
use std::str::FromStr;

let upc_a = UpcA::from_str("123456789012")?;
assert_eq!(upc_a.to_code(), 123456789012);

pub const fn from_bytes(bytes: &[u8; 5]) -> Result<Self, UpcAParseError>

Creates a UpcA from a 5-byte binary representation.

This method deserializes a UPC-A code from its compact binary representation, which is primarily useful for binary serialization formats.

Examples

use upc_a::UpcA;

let bytes = [0x14, 0x1A, 0x99, 0xBE, 0x1C];
let upc_a = UpcA::from_bytes(&bytes)?;
assert_eq!(upc_a.to_code(), 123456789012);

Errors

Returns an UpcAParseError if:

• The integer value exceeds the maximum allowed value (999,999,999,999)
• The checksum digit is invalid

pub const fn to_bytes(self) -> [u8; 5]

Converts the UpcA to its compact 5-byte binary representation.

This method serializes a UPC-A code into a fixed-size array suitable for binary storage or transmission. It is the inverse of from_bytes.

Examples

use upc_a::UpcA;
use std::str::FromStr;

let upc_a = UpcA::from_code(123456789012)?;
let bytes = upc_a.to_bytes();
assert_eq!(bytes, *b"\x14\x1A\x99\xBE\x1C");

// Round-trip conversion
let round_trip = UpcA::from_bytes(&bytes)?;
assert_eq!(round_trip, upc_a);

Trait Implementations

impl Clone for UpcA

fn clone(&self) -> UpcA

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpcA

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

Formats the value using the given formatter.

impl Display for UpcA

Implements the Display trait for UpcA to provide a string representation.

Examples

use upc_a::UpcA;

let upc_a = UpcA::from_code(123456789012)?;
assert_eq!(upc_a.to_string(), "123456789012");

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

Formats the value using the given formatter.

impl FromStr for UpcA

Implements the FromStr trait for UpcA to allow parsing from strings using the parse method.

This implementation delegates to UpcA::from_code.

Examples

use upc_a::UpcA;
use std::str::FromStr;

// Parse using FromStr
let upc_a = UpcA::from_str("123456789012")?;

// Or using the more idiomatic parse method
let upc_a: UpcA = "123456789012".parse()?;

type Err = UpcAParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, UpcAParseError>

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

impl Hash for UpcA

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

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 Ord for UpcA

fn cmp(&self, other: &UpcA) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UpcA

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

fn partial_cmp(&self, other: &UpcA) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for UpcA

impl Eq for UpcA

impl StructuralPartialEq for UpcA