Enum TransactionType 

#[non_exhaustive]
pub enum TransactionType {
    Buy,
    Sell,
    Award,
    Exercise,
    Gift,
    Conversion,
    Other(OtherTransactionType),
}

Transaction types for insider activities with canonical variants and extensible fallback.

This enum provides type-safe handling of transaction types while gracefully handling unknown or provider-specific transaction types through the Other variant.

Canonical/serde rules:

• Emission uses a single canonical form per variant (UPPERCASE ASCII, no spaces)
• Parser accepts a superset of tokens (aliases, case-insensitive)
• Other(s) serializes to its canonical code() string (no escape prefix)
• Display output matches the canonical code for known variants and the raw s for Other(s)
• Serde round-trips preserve identity for canonical variants; unknown tokens normalize to Other(UPPERCASE)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Buy

Purchase or acquisition of shares

Sell

Sale or disposal of shares

Award

Stock award or grant

Exercise

Exercise of options

Gift

Gift of shares

Conversion

Conversion of securities

Other(OtherTransactionType)

Unknown or provider-specific transaction type

Implementations

impl TransactionType

pub fn try_from_str(input: &str) -> Result<TransactionType, FundamentalsError>

Attempts to parse a transaction type, uppercasing unknown inputs into Other.

Errors

Returns FundamentalsError::InvalidEnumValue when input is empty/whitespace.

pub fn other(input: &str) -> Result<TransactionType, FundamentalsError>

Builds an unknown transaction type, rejecting modeled types and aliases.

Errors

Returns an error if input is empty, cannot be canonicalized, or parses to a modeled TransactionType variant.

impl TransactionType

pub fn code(&self) -> &str

Returns the canonical string code for this value.

impl TransactionType

pub const fn is_canonical(&self) -> bool

Returns true when this value represents a canonical variant.

Trait Implementations

impl AsRef<str> for TransactionType

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TransactionType

fn clone(&self) -> TransactionType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionType

fn deserialize<D>( deserializer: D, ) -> Result<TransactionType, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransactionType

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

Formats the value using the given formatter.

impl Eq for TransactionType

impl FromStr for TransactionType

type Err = FundamentalsError

The associated error which can be returned from parsing.

fn from_str( input: &str, ) -> Result<TransactionType, <TransactionType as FromStr>::Err>

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

impl Hash for TransactionType

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 TransactionType

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TransactionType

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 StringCode for TransactionType

fn code(&self) -> &str

Returns the canonical string code for this value.

fn is_canonical(&self) -> bool

Whether this value is a canonical enum variant (not an Other payload).

impl StructuralPartialEq for TransactionType

impl TryFrom<String> for TransactionType

type Error = FundamentalsError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<TransactionType, <TransactionType as TryFrom<String>>::Error>

Performs the conversion.