ifsc 0.1.1

A fast offline directory for Indian bank branches and IFSCs
Documentation
use crate::{BankService, BranchRail, ReportedStatus};

/// Coverage of one field in the bundled branch directory.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Coverage {
    present: usize,
    total: usize,
}
impl Coverage {
    /// Returns records that contain the field.
    pub const fn present(self) -> usize {
        self.present
    }
    /// Returns all records considered.
    pub const fn total(self) -> usize {
        self.total
    }
    /// Returns the present-record fraction from `0.0` through `1.0`.
    pub fn ratio(self) -> f64 {
        self.present as f64 / self.total as f64
    }
}

/// Aggregate facts derived from the bundled Razorpay snapshot.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Statistics {
    _private: (),
}
impl crate::Directory {
    /// Returns aggregate facts for the bundled snapshot.
    pub const fn statistics(self) -> Statistics {
        Statistics { _private: () }
    }
}
impl Statistics {
    /// Returns the number of branch records.
    pub fn branches(self) -> usize {
        crate::snapshot::branch_count() as usize
    }
    /// Returns the number of distinct IFSC routing prefixes.
    pub fn routing_codes(self) -> usize {
        let mut previous = None;
        crate::directory()
            .branches()
            .filter(|b| {
                let v = b.routing_code();
                let changed = previous != Some(v);
                previous = Some(v);
                changed
            })
            .count()
    }
    /// Returns the number of named banks.
    pub fn banks(self) -> usize {
        crate::snapshot::bank_name_count() as usize
    }
    /// Returns the number of bank profiles.
    pub fn bank_profiles(self) -> usize {
        crate::snapshot::bank_profile_count() as usize
    }
    /// Returns the number of exact sublet rules.
    pub fn exact_sublet_rules(self) -> usize {
        crate::snapshot::exact_sublet_count() as usize
    }
    /// Returns the number of custom prefix rules.
    pub fn custom_sublet_rules(self) -> usize {
        crate::snapshot::custom_sublet_count() as usize
    }
    /// Counts branches reporting the selected rail.
    pub fn branch_rail_count(self, rail: BranchRail) -> usize {
        crate::directory().branches_reporting(rail).count()
    }
    /// Counts bank profiles with the selected reported status.
    pub fn bank_service_count(self, service: BankService, status: ReportedStatus) -> usize {
        crate::directory()
            .bank_profiles()
            .filter(|p| p.reported_status(service) == status)
            .count()
    }
    /// Returns coverage of reported bank names.
    pub fn reported_bank_name_coverage(self) -> Coverage {
        coverage(|b| b.reported_bank_name().is_some())
    }
    /// Returns coverage of contacts.
    pub fn contact_coverage(self) -> Coverage {
        coverage(|b| b.contact().is_some())
    }
    /// Returns coverage of states.
    pub fn state_coverage(self) -> Coverage {
        coverage(|b| b.state().is_some())
    }
    /// Returns coverage of ISO subdivision values.
    pub fn iso_subdivision_coverage(self) -> Coverage {
        coverage(|b| b.iso_subdivision().is_some())
    }
    /// Returns coverage of MICR values.
    pub fn micr_coverage(self) -> Coverage {
        coverage(|b| b.micr().is_some())
    }
    /// Returns coverage of SWIFT values.
    pub fn swift_coverage(self) -> Coverage {
        coverage(|b| b.swift().is_some())
    }
}
fn coverage(is_present: impl Fn(crate::Branch) -> bool) -> Coverage {
    let total = crate::snapshot::branch_count() as usize;
    let present = crate::directory()
        .branches()
        .filter(|branch| is_present(*branch))
        .count();
    Coverage { present, total }
}