Skip to main content

MatchBreakdown

Struct MatchBreakdown 

Source
pub struct MatchBreakdown {
Show 56 fields pub uk_nhs_number_score: Option<f64>, pub fr_nir_score: Option<f64>, pub es_tsi_score: Option<f64>, pub ie_ihi_score: Option<f64>, pub uk_hc_number_score: Option<f64>, pub us_ssn_score: Option<f64>, pub au_ihi_score: Option<f64>, pub de_kvnr_score: Option<f64>, pub it_cf_score: Option<f64>, pub nl_bsn_score: Option<f64>, pub se_workernummer_score: Option<f64>, pub uk_chi_number_score: Option<f64>, pub be_nn_score: Option<f64>, pub bg_egn_score: Option<f64>, pub cz_rc_score: Option<f64>, pub dk_cpr_score: Option<f64>, pub ee_ik_score: Option<f64>, pub es_dni_score: Option<f64>, pub fi_hetu_score: Option<f64>, pub hr_oib_score: Option<f64>, pub is_kt_score: Option<f64>, pub lt_ak_score: Option<f64>, pub lv_pk_score: Option<f64>, pub mt_id_score: Option<f64>, pub no_fnr_score: Option<f64>, pub pl_pesel_score: Option<f64>, pub ro_cnp_score: Option<f64>, pub si_emso_score: Option<f64>, pub sk_rc_score: Option<f64>, pub uk_nino_score: Option<f64>, pub gr_dss_score: Option<f64>, pub li_id_score: Option<f64>, pub nl_id_score: Option<f64>, pub pl_nip_score: Option<f64>, pub pt_nif_score: Option<f64>, pub br_cpf_score: Option<f64>, pub cn_rrn_score: Option<f64>, pub in_aadhaar_score: Option<f64>, pub jp_my_number_score: Option<f64>, pub mx_curp_score: Option<f64>, pub nz_nhi_score: Option<f64>, pub za_id_score: Option<f64>, pub passport_book_score: Option<f64>, pub given_name_score: Option<f64>, pub family_name_score: Option<f64>, pub date_of_birth_score: Option<f64>, pub gender_score: Option<f64>, pub blood_type_score: Option<f64>, pub multiple_birth_score: Option<f64>, pub address_score: Option<f64>, pub birth_place_score: Option<f64>, pub death_date_score: Option<f64>, pub death_place_score: Option<f64>, pub phone_score: Option<f64>, pub email_score: Option<f64>, pub phonetic_name_score: Option<f64>,
}
Expand description

Per-field score breakdown returned with every MatchResult.

Each field is Option<f64>:

  • Some(score) — the field was scored; the value is in [0.0, 1.0].
  • None — the field was missing on at least one side and so did not participate in the weighted sum.

The breakdown exists so a clinician or auditor can see why a match was flagged. Do not throw it away in downstream services.

Fields§

§uk_nhs_number_score: Option<f64>

Score for UK NHS Number equality (1.0 or 0.0), or None if either side did not parse.

§fr_nir_score: Option<f64>

Score for France NIR equality (1.0 or 0.0), or None if either side did not parse.

§es_tsi_score: Option<f64>

Score for España TSI / CIP-SNS equality (1.0 or 0.0), or None if either side did not parse.

§ie_ihi_score: Option<f64>

Score for Éire IHI equality (1.0 or 0.0), or None if either side did not parse.

§uk_hc_number_score: Option<f64>

Score for United Kingdom Northern Ireland H&C Number equality (1.0 or 0.0), or None if either side did not parse.

§us_ssn_score: Option<f64>

Score for United States Social Security Number equality (1.0 or 0.0), or None if either side did not parse.

§au_ihi_score: Option<f64>

Score for Australia IHI equality (1.0 or 0.0), or None if either side did not parse.

§de_kvnr_score: Option<f64>

Score for Germany KVNR equality (1.0 or 0.0), or None if either side did not parse.

§it_cf_score: Option<f64>

Score for Italy Codice Fiscale equality (1.0 or 0.0), or None if either side did not parse.

§nl_bsn_score: Option<f64>

Score for Netherlands BSN equality (1.0 or 0.0), or None if either side did not parse.

§se_workernummer_score: Option<f64>

Score for Sweden Workernummer equality (1.0 or 0.0), or None if either side did not parse.

§uk_chi_number_score: Option<f64>

Score for United Kingdom (Scotland) CHI Number equality (1.0 or 0.0), or None if either side did not parse.

§be_nn_score: Option<f64>

Score for Belgium National Number equality (1.0 or 0.0), or None.

§bg_egn_score: Option<f64>

Score for Bulgaria EGN equality (1.0 or 0.0), or None.

§cz_rc_score: Option<f64>

Score for Czech Rodné číslo equality (1.0 or 0.0), or None.

§dk_cpr_score: Option<f64>

Score for Denmark CPR equality (1.0 or 0.0), or None.

§ee_ik_score: Option<f64>

Score for Estonia Isikukood equality (1.0 or 0.0), or None.

§es_dni_score: Option<f64>

Score for Spain DNI / NIE equality (1.0 or 0.0), or None.

§fi_hetu_score: Option<f64>

Score for Finland HETU equality (1.0 or 0.0), or None.

§hr_oib_score: Option<f64>

Score for Croatia OIB equality (1.0 or 0.0), or None.

§is_kt_score: Option<f64>

Score for Iceland Kennitala equality (1.0 or 0.0), or None.

§lt_ak_score: Option<f64>

Score for Lithuania Asmens kodas equality (1.0 or 0.0), or None.

§lv_pk_score: Option<f64>

Score for Latvia Workeras kods equality (1.0 or 0.0), or None.

§mt_id_score: Option<f64>

Score for Malta National ID equality (1.0 or 0.0), or None.

§no_fnr_score: Option<f64>

Score for Norway Fødselsnummer equality (1.0 or 0.0), or None.

§pl_pesel_score: Option<f64>

Score for Poland PESEL equality (1.0 or 0.0), or None.

§ro_cnp_score: Option<f64>

Score for Romania CNP equality (1.0 or 0.0), or None.

§si_emso_score: Option<f64>

Score for Slovenia EMŠO equality (1.0 or 0.0), or None.

§sk_rc_score: Option<f64>

Score for Slovakia Rodné číslo equality (1.0 or 0.0), or None.

§uk_nino_score: Option<f64>

Score for UK NINO equality (1.0 or 0.0), or None.

§gr_dss_score: Option<f64>

Score for Greece DSS investor-share equality (1.0 or 0.0), or None.

§li_id_score: Option<f64>

Score for Liechtenstein National ID equality (1.0 or 0.0), or None.

§nl_id_score: Option<f64>

Score for Netherlands National ID equality (1.0 or 0.0), or None.

§pl_nip_score: Option<f64>

Score for Poland NIP equality (1.0 or 0.0), or None.

§pt_nif_score: Option<f64>

Score for Portugal NIF equality (1.0 or 0.0), or None.

§br_cpf_score: Option<f64>

Score for Brazil CPF equality (1.0 or 0.0), or None.

§cn_rrn_score: Option<f64>

Score for China Resident Identity Card equality (1.0 or 0.0), or None.

§in_aadhaar_score: Option<f64>

Score for India Aadhaar equality (1.0 or 0.0), or None.

§jp_my_number_score: Option<f64>

Score for Japan My Number equality (1.0 or 0.0), or None.

§mx_curp_score: Option<f64>

Score for Mexico CURP equality (1.0 or 0.0), or None.

§nz_nhi_score: Option<f64>

Score for New Zealand NHI equality (1.0 or 0.0), or None.

§za_id_score: Option<f64>

Score for South Africa ID Number equality (1.0 or 0.0), or None.

§passport_book_score: Option<f64>

Score for passport-book match: Some(1.0) when at least one (country, number) pair is shared across the two workers’ passport lists, Some(0.0) when both have at least one book but no pair is shared, None when either side has no books. See spec §6.4a / FR-51.

§given_name_score: Option<f64>

Score for given-name similarity using the configured algorithm.

§family_name_score: Option<f64>

Score for family-name similarity using the configured algorithm.

§date_of_birth_score: Option<f64>

Score for date-of-birth equality (1.0 or 0.0).

§gender_score: Option<f64>

Score for gender equality (1.0 or 0.0).

§blood_type_score: Option<f64>

Score for ABO+RhD blood-type equality (1.0 or 0.0), or None if either side is missing. See crate::BloodType.

§multiple_birth_score: Option<f64>

Score for multiple-birth indicator equality (1.0 for matching birth order, 0.0 for different birth orders within the same multiple-birth set), or None if either side is missing.

§address_score: Option<f64>

Score for address similarity (weighted blend of postcode, city, line 1).

§birth_place_score: Option<f64>

Score for place-of-birth similarity (city Jaro-Winkler blended with country exact match), or None if either side is absent or carries no city / country sub-fields.

§death_date_score: Option<f64>

Score for date-of-death equality, using the same DOB transposition heuristic as Self::date_of_birth_score: 1.0 on exact equality, 0.5 on day/month swap, 0.0 otherwise. None if either side has no recorded death date.

§death_place_score: Option<f64>

Score for place-of-death similarity (analogous to Self::birth_place_score: city Jaro-Winkler blended with country exact match), or None if either side is absent or carries no city / country sub-fields.

§phone_score: Option<f64>

Score for normalised phone-number equality (1.0 or 0.0).

§email_score: Option<f64>

Score for normalised email-address equality (1.0 or 0.0). None if either side is absent or fails to parse as an email.

§phonetic_name_score: Option<f64>

Mean Soundex match across given and family names (0.0, 0.5, or 1.0).

Trait Implementations§

Source§

impl Clone for MatchBreakdown

Source§

fn clone(&self) -> MatchBreakdown

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
Source§

impl Debug for MatchBreakdown

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MatchBreakdown

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for MatchBreakdown

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,