Skip to main content

LegTerms

helixrs::cashflows::legs

Struct LegTerms

pub struct LegTerms {
    pub notional: f64,
    pub day_count: DayCountFraction,
    pub currency: Currency,
    pub direction: Direction,
    pub payment: PaymentRule,
}

Expand description

The terms every leg shares, whatever its coupons pay.

Bundled rather than passed one by one: these travel together, and a builder that takes eight positional arguments is one a caller gets wrong silently.

Fields§

§notional: f64

The notional every coupon accrues on.

§day_count: DayCountFraction

The accrual day count.

§currency: Currency

The currency the leg pays in.

§direction: Direction

Which side the leg is on.

§payment: PaymentRule

How accrual ends become payment dates.

Trait Implementations§

impl Clone for LegTerms

fn clone(&self) -> LegTerms

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for LegTerms

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for LegTerms

impl !UnwindSafe for LegTerms

impl Freeze for LegTerms

impl Send for LegTerms

impl Sync for LegTerms

impl Unpin for LegTerms

impl UnsafeUnpin for LegTerms

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.