Struct ReferenceEntity 

pub struct ReferenceEntity {
    pub entity: String,
    pub seniority: Seniority,
    pub doc_clause: DocClause,
}

What a single-name credit contract references: the entity, the seniority of the debt it protects and the documentation clause it trades under.

Spelled ENTITY/SENIORITY/DOCCLAUSE, read from the right — the seniority and the clause are closed vocabularies, so the entity may itself hold a / and still parse back. Ordered by the three fields in that order, so a market keyed by it enumerates an issuer’s tiers together.

Fields

entity: String

The reference entity’s name — a free string, as a RED code or an LEI would be if a registry supplied it.

seniority: Seniority

The repayment seniority of the debt the contract protects.

doc_clause: DocClause

The documentation clause the contract trades under.

Implementations

impl ReferenceEntity

pub fn new( entity: impl Into<String>, seniority: Seniority, doc_clause: DocClause, ) -> Self

A reference entity, every part stated; the entity’s surrounding whitespace taken off, as its spelling’s parser takes it off.

pub fn in_currency(self, currency: Currency) -> CreditCurveId

This reference in currency: the identity the market keys its curve by.

Trait Implementations

impl Clone for ReferenceEntity

fn clone(&self) -> ReferenceEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceEntity

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

Formats the value using the given formatter.

impl Display for ReferenceEntity

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

Formats the value using the given formatter.

impl Eq for ReferenceEntity

impl FromStr for ReferenceEntity

type Err = CreditIdParseError

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 Hash for ReferenceEntity

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 Ord for ReferenceEntity

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

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

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