Struct Cfi 

pub struct Cfi { /* private fields */ }

A validated CFI (Classification of Financial Instruments, ISO 10962).

Cfi is a 6-byte, Copy, allocation-free value object. Once constructed, it is guaranteed to describe a category, group, and four attribute codes defined by ISO 10962 — there is no way to get a Cfi that hasn’t passed validation.

Internally, the identifier is stored as raw uppercase ASCII letters ('A'...='Z').

Constructing a Cfi

Constructor	Accepts
Cfi::parse / Cfi::new	6-character strings, any ASCII case, trimmed
Cfi::from_bytes	Exactly 6 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 CfiError on failure. See the module-level documentation for the segment layout and design rationale.

Implementations

impl Cfi

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

Parses a CFI from a string.

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

Errors

Returns CfiError if the input is empty, does not contain exactly 6 characters after trimming, contains a non-letter character, or names a category, group, or attribute code that ISO 10962 does not define.

Examples

use ftracker_identifiers::Cfi;

assert!(Cfi::parse("ESVUFR").is_ok());
assert!(Cfi::parse("esvufr").is_ok()); // lowercase is folded automatically
assert!(Cfi::parse(" ESVUFR ").is_ok()); // surrounding whitespace is trimmed
assert!(Cfi::parse("EZVUFR").is_err()); // 'Z' is not a group of category 'E'

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

Alias for Cfi::parse.

Errors

See Cfi::parse.

Examples

use ftracker_identifiers::Cfi;

assert_eq!(Cfi::new("ESVUFR"), Cfi::parse("ESVUFR"));

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

Constructs a Cfi directly from 6 raw ASCII bytes.

Each byte must already be an uppercase letter valid for its position. Use Cfi::parse if the input might contain surrounding whitespace or lowercase letters.

Errors

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

Examples

use ftracker_identifiers::Cfi;

let cfi = Cfi::from_bytes(*b"ESVUFR").unwrap();
assert_eq!(cfi.as_str(), "ESVUFR");

// An undefined attribute code is rejected just like it would be through `parse`.
assert!(Cfi::from_bytes(*b"ESZUFR").is_err());

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

Returns the 6 raw ASCII bytes backing this CFI (for example, b"ESVUFR").

Examples

use ftracker_identifiers::Cfi;

let cfi = Cfi::parse("ESVUFR").unwrap();
assert_eq!(cfi.as_bytes(), b"ESVUFR");

pub fn as_str(&self) -> &str

Returns the full 6-character CFI as a &str.

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

Examples

use ftracker_identifiers::Cfi;

let cfi = Cfi::parse("ESVUFR").unwrap();
assert_eq!(cfi.as_str(), "ESVUFR");

pub fn category(&self) -> char

Returns the category code (position 1).

Examples

use ftracker_identifiers::Cfi;

let cfi = Cfi::parse("ESVUFR").unwrap();
assert_eq!(cfi.category(), 'E');

pub fn group(&self) -> char

Returns the group code (position 2).

Examples

use ftracker_identifiers::Cfi;

let cfi = Cfi::parse("ESVUFR").unwrap();
assert_eq!(cfi.group(), 'S');

pub fn attributes(&self) -> [char; 4]

Returns the four attribute codes (positions 3–6), in order.

Examples

use ftracker_identifiers::Cfi;

let cfi = Cfi::parse("ESVUFR").unwrap();
assert_eq!(cfi.attributes(), ['V', 'U', 'F', 'R']);

Trait Implementations

impl<'a> Arbitrary<'a> for Cfi

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 Cfi

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

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

impl AsRef<str> for Cfi

fn as_ref(&self) -> &str

Equivalent to Cfi::as_str.

impl Clone for Cfi

fn clone(&self) -> Cfi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Cfi

impl Debug for Cfi

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cfi

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Cfi

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

Formats the value using the given formatter.

impl Eq for Cfi

impl FromStr for Cfi

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

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

type Err = CfiError

The associated error which can be returned from parsing.

impl Hash for Cfi

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 Cfi

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 Cfi

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for Cfi

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

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

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

Inequality operator !=.

impl PartialEq<Cfi> for str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Cfi> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for Cfi

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

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

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

Inequality operator !=.

impl PartialOrd for Cfi

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

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 Cfi

impl TryFrom<&[u8]> for Cfi

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

Validates a byte slice as a CFI. The slice must be exactly 6 pre normalized uppercase ASCII bytes; any other length yields CfiError::InvalidLength. Once the length is confirmed, this behaves like Cfi::from_bytes.

type Error = CfiError

The type returned in the event of a conversion error.

impl TryFrom<&str> for Cfi

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

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

type Error = CfiError

The type returned in the event of a conversion error.

impl TryFrom<[u8; 6]> for Cfi

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

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

type Error = CfiError

The type returned in the event of a conversion error.