Enum SwaptionKind 

pub enum SwaptionKind {
    Payer,
    Receiver,
}

Whether a swaption holder pays (payer) or receives (receiver) the fixed leg on exercise. A payer is a call on the forward swap rate; a receiver a put.

Filed here for the same reason as AccrualCompounding: it classifies a contract convention and is named by swaption templates, so keeping it with the instrument would invert the layering.

Variants

Payer

Right to enter paying fixed (a call on the swap rate).

Receiver

Right to enter receiving fixed (a put on the swap rate).

Implementations

impl SwaptionKind

pub const ACCEPTED: &'static [&'static str]

Every spelling this vocabulary accepts, canonical forms first.

Matching additionally ignores case and _/-/whitespace — see normalize in core::vocabulary.

pub fn code(self) -> &'static str

The canonical code for this variant; round-trips through FromStr.

Trait Implementations

impl Clone for SwaptionKind

fn clone(&self) -> SwaptionKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SwaptionKind

impl Debug for SwaptionKind

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

Formats the value using the given formatter.

impl Eq for SwaptionKind

impl FromStr for SwaptionKind

type Err = VocabularyParseError

The associated error which can be returned from parsing.

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

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

impl PartialEq for SwaptionKind

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