Struct Isin 

pub struct Isin { /* private fields */ }

A validated ISIN (International Securities Identification Number, ISO 6166).

Isin is a 12-byte, Copy, allocation-free value object. Once constructed, it is guaranteed to satisfy the structural rules and Luhn check digit required by ISO 6166 — there is no way to obtain an Isin that hasn’t passed validation.

Internally, the identifier is stored as raw uppercase ASCII bytes ('0'..='9' or 'A'..='Z').

Constructing an Isin

Constructor	Accepts
Isin::parse / Isin::new	12-character strings, any ASCII case, trimmed
Isin::from_bytes	Exactly 12 pre-normalized uppercase ASCII bytes
FromStr / TryFrom<&str>	Same as parse, for use in generic code

All of them run the same validation and return IsinError on failure. See the module-level documentation for the segment layout and design rationale.

Implementations

impl Isin

pub fn parse(input: &str) -> Result<Self, IsinError>

Parses an ISIN from a string.

The parser trims surrounding whitespace and folds ASCII letters to uppercase before validation. This is the primary constructor; Isin::new, FromStr, and TryFrom<&str> all delegate to it.

Errors

Returns IsinError if the input is empty, does not contain exactly 12 characters after trimming, contains a character invalid for its position, or fails the Luhn check digit.

Examples

use ftracker_identifiers::Isin;

assert!(Isin::parse("US0378331005").is_ok());
assert!(Isin::parse("us0378331005").is_ok()); // lowercase is folded automatically
assert!(Isin::parse(" US0378331005 ").is_ok()); // surrounding whitespace is trimmed
assert!(Isin::parse("US0378331006").is_err()); // wrong check digit

pub fn new(input: &str) -> Result<Self, IsinError>

Alias for Isin::parse.

Errors

See Isin::parse.

Examples

use ftracker_identifiers::Isin;

assert_eq!(Isin::new("US0378331005"), Isin::parse("US0378331005"));

pub fn from_bytes(bytes: [u8; 12]) -> Result<Self, IsinError>

Constructs an Isin directly from 12 raw ASCII bytes.

Each byte must already be uppercase and valid for its position (two letters, nine alphanumerics, one digit). Use Isin::parse if the input might contain surrounding whitespace or lowercase letters.

Errors

Returns IsinError under the same conditions as Isin::parse, except that length is guaranteed by the [u8; 12] type itself: IsinError::InvalidLength cannot occur here.

Examples

use ftracker_identifiers::Isin;

let isin = Isin::from_bytes(*b"US0378331005").unwrap();
assert_eq!(isin.as_str(), "US0378331005");

// A malformed checksum is rejected just like it would be through `parse`.
assert!(Isin::from_bytes(*b"US0378331006").is_err());

pub fn as_bytes(&self) -> &[u8; 12]

Returns the 12 raw ASCII bytes backing this ISIN (for example, b"US0378331005").

Examples

use ftracker_identifiers::Isin;

let isin = Isin::parse("US0378331005").unwrap();
assert_eq!(isin.as_bytes(), b"US0378331005");

pub fn as_str(&self) -> &str

Returns the full 12-character ISIN as a &str.

This never allocates: the bytes are guaranteed to be valid ASCII by construction.

Examples

use ftracker_identifiers::Isin;

let isin = Isin::parse("US0378331005").unwrap();
assert_eq!(isin.as_str(), "US0378331005");

pub fn country_code(&self) -> &str

Returns the two-character ISO 3166-1 alpha-2 country code (positions 1–2).

Examples

use ftracker_identifiers::Isin;

let isin = Isin::parse("US0378331005").unwrap();
assert_eq!(isin.country_code(), "US");

pub fn country(&self) -> Option<CountryCode>

Returns the prefix (positions 1-2) as a validated CountryCode, or None when it is not an officially assigned ISO 3166-1 alpha-2 code.

An Isin only validates its prefix structurally (two uppercase letters), so it can carry prefixes that ISO 6166 reserves but ISO 3166-1 does not assign. The most common are XS (used by international clearing systems such as Euroclear and Clearstream), EU (European Union supranational issues), and QS. For those, this returns None even though the Isin itself is valid. Use Isin::country_code when you want the raw two letter prefix regardless of assignment.

Examples

use ftracker_identifiers::{Isin, CountryCode};

let apple = Isin::parse("US0378331005").unwrap();
assert_eq!(apple.country(), Some(CountryCode::parse("US").unwrap()));

pub fn nsin(&self) -> &str

Returns the nine-character National Securities Identifying Number (positions 3–11).

Examples

use ftracker_identifiers::Isin;

let isin = Isin::parse("US0378331005").unwrap();
assert_eq!(isin.nsin(), "037833100");

pub fn check_digit(&self) -> u8

Returns the Luhn check digit (position 12) as a numeric value.

For a valid Isin, this always equals Isin::computed_check_digit.

Examples

use ftracker_identifiers::Isin;

let isin = Isin::parse("US0378331005").unwrap();
assert_eq!(isin.check_digit(), 5);

pub fn computed_check_digit(&self) -> u8

Recomputes the check digit that the ISO 6166 Luhn algorithm produces from the first 11 characters of this value.

For a valid Isin this always matches Isin::check_digit; the method exists so callers can reproduce the algorithm’s output without a separate crate.

Examples

use ftracker_identifiers::Isin;

let isin = Isin::parse("US0378331005").unwrap();
assert_eq!(isin.computed_check_digit(), isin.check_digit());

Trait Implementations

impl<'a> Arbitrary<'a> for Isin

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<[u8]> for Isin

fn as_ref(&self) -> &[u8]

Equivalent to Isin::as_bytes, borrowed as a slice.

impl AsRef<str> for Isin

fn as_ref(&self) -> &str

Equivalent to Isin::as_str.

impl Clone for Isin

fn clone(&self) -> Isin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Isin

impl Debug for Isin

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Isin

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Isin

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

Formats the value using the given formatter.

impl Eq for Isin

impl FromStr for Isin

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

Delegates to Isin::parse, enabling input.parse::<Isin>() and use in generic code bounded by FromStr.

type Err = IsinError

The associated error which can be returned from parsing.

impl Hash for Isin

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 JsonSchema for Isin

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Isin

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Isin

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

Compares against a string slice by its canonical 12 character representation.

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

Inequality operator !=.

impl PartialEq<Isin> for str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Isin> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Isin

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

Compares against a string slice by its canonical 12 character representation.

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

Inequality operator !=.

impl PartialOrd for Isin

fn partial_cmp(&self, other: &Isin) -> 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 Serialize for Isin

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Isin

impl TryFrom<&[u8]> for Isin

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Validates a byte slice as an ISIN. The slice must be exactly 12 pre normalized uppercase ASCII bytes; any other length yields IsinError::InvalidLength. Once the length is confirmed, this behaves like Isin::from_bytes.

type Error = IsinError

The type returned in the event of a conversion error.

impl TryFrom<&str> for Isin

fn try_from(value: &str) -> Result<Self, Self::Error>

Delegates to Isin::parse, enabling Isin::try_from(input) and use in generic code bounded by TryFrom<&str>.

type Error = IsinError

The type returned in the event of a conversion error.

impl TryFrom<[u8; 12]> for Isin

fn try_from(value: [u8; 12]) -> Result<Self, Self::Error>

Delegates to Isin::from_bytes. The bytes must already be pre normalized uppercase ASCII.

type Error = IsinError

The type returned in the event of a conversion error.