Module bond_readings 

The bond readings a desk takes over an instrument and a market, spelled and ordered as the Python bonds module spells them.

Each verb here does three things the binding used to do for Python alone: it takes the product its reading is about out of the AnyInstrument, refusing any other product with the typed error naming the verb; it lifts, views and resolves the market through the same seam a valuation walks; and it calls the view-level body — the _with form a caller holding a resolved view uses directly. A Rust reader therefore writes callable_oas(&instrument, &market, 98.5) where a Python reader writes bonds.callable_oas(instrument, market, 98.5).

Enums

BondReadingError

Why a callable’s curve-free yield could not be read.

Functions

accreted_face

A payment-in-kind bond’s face on date: the par face grown by every capitalisation on or before it.

accreted_redemption

A payment-in-kind bond’s redemption per 100 of par face.

bond_future_option_diagnostics

The quantities an option on a bond future is priced from, per 100 — the quoted futures price, the vol and its convention, the time, the discount factor, the European value, the early-exercise premium and the critical futures price where Barone-Adesi–Whaley applies.

bond_option_diagnostics

A bond option’s pricing diagnostics against market, under the yield-vol engine.

callable_oas

The option-adjusted spread of a callable bond at clean_price against market, solved passively. A callable loan is quoted per 100 of its outstanding at the valuation, once drawn and untagged.

capitalisations

A payment-in-kind bond’s capitalisations as a table: date, rate, year_fraction, face_before, face_after and amount, one row per capitalisation in order.

clean_price_at_oas

The clean price of a callable bond at oas against market, or of a callable loan per 100 of its outstanding.

discount_margin

A floating-rate note’s discount margin at quoted_clean against market.

effective_risk

The callable’s price and its first two sensitivities to a parallel continuous shift of the discounting at oas, from one lattice pass.

fair_margin

A bond total return swap’s fair funding margin against market.

forward_price

A fixed-rate bond’s forward price on forward_date against market, clean or dirty by basis, carried on the repo curve under repo_key or on the discount curve itself.

note_dirty_price

A structured note’s dirty price per 100 against market.

note_z_spread

A structured note’s z-spread at dirty_price against market.

package_value

A repo’s value with its collateral: the cash leg plus the bond received, less the bond returned at its repo forward, less — classic — the coupons manufactured back.

repo_margin

A repo’s margin position against market: exposure, collateral value on the margin basis, what the margin ratio requires, the excess, and the haircut. The collateral is priced off its curves, or at price per 100 when the desk marks it from a screen.

resolved_bond_view 🔒

The curves a fixed-rate bond reads for a spread measure: its currency’s discount, overlaid by the security spread under security_spread where one is named, or financed on the repo curve under repo_key.

settlement_date

The date a payment-in-kind bond traded on trade_date settles on: its settlement lag walked from it, never before issue.

simple_margin

A floating-rate note’s simple margin at quoted_clean on settlement: the closed form, no curve and no solve.

spread_duration

A floating-rate note’s spread duration against market.

yield_to_call

The yield to the exercise entry on date at dirty_price, under the basis convention resolves to on the bond’s frequency, re-based on day_count where one is given.

yield_to_maturity_scenario

The yield of the redemption-at-par-on-maturity scenario at dirty_price.

yield_to_worst

The lowest yield over the maturity scenario and every exercise after settlement, with the date attaining it.

z_spread

A fixed-rate bond’s z-spread at price (clean or dirty by basis) over its currency’s discount curve on market, overlaid by the security spread under security_spread where one is named.

zero_coupon_quotes

A zero’s five quotes: price, discount yield, money-market yield, bond-equivalent yield and the yield its market quotes.