Struct BankClearanceRepository 

pub struct BankClearanceRepository(/* private fields */);

Repository for BankClearance entities.

All standard CRUD, soft-delete, pagination, and bulk methods are provided automatically via Deref to backbone_orm::GenericCrudRepository.

Implementations

impl BankClearanceRepository

pub fn new(pool: PgPool) -> Self

Create a new repository instance.

impl BankClearanceRepository

Hand-written BankClearance SQL. Lives here (not in the write service) per the module’s 4-layer rule. The settlement-dimension DECISION (does this clearance overrun the settled document?) stays in the service — this layer only locks and sums.

pub async fn sums_cleared_for_payments( &self, pool: &PgPool, payment_ids: &[Uuid], ) -> Result<HashMap<Uuid, Decimal>, Error>

Serialize clearances against one settlement with an advisory xact lock, so two concurrent Sum of cleared amounts per payment, over a candidate set — the reconcile-preset ordering’s open-amount input. Reads banking’s OWN clearance table (the same amounts the clear verb’s settlement bound counts), so ordering and clearing can never disagree about what is open. Pool-based read; an empty id list returns an empty map.

Tenancy (ADR-0029): when the request carries an ambient org scope it is relayed onto a short read transaction (bind_org_scope_on), so the composing service’s row-level fence applies — an unscoped read under a live fence would return an empty cleared-map and let candidate ordering present fully-open amounts for payments already cleared. Unfenced deployments read the pool plain. (backbone_orm’s org scope offers no fetch-all helper, so the scoped path is a short read-only transaction here.)

pub async fn lock_settlement( &self, conn: &mut PgConnection, matched_source_id: Uuid, ) -> Result<(), Error>

first-clears cannot race the Self::sum_cleared_against_settlement phantom-insert.

Takes the CALLER’S connection: an xact lock is released at commit, so it MUST be taken on the same transaction that runs the SUM and writes the clearance.

The lock keys on the settlement id alone: a settlement id is a globally unique UUID, so two operators — in any unit — clearing the same settlement serialize against each other. The org fence itself is the composing service’s tenancy decorator (ADR-0029), not this lock.

pub async fn sum_cleared_against_settlement( &self, conn: &mut PgConnection, matched_source_type: &str, matched_source_id: Uuid, ) -> Result<Decimal, Error>

Sum every clearance already booked against one settlement — the settlement-dimension bound’s input, which is what stops one payment being cleared twice (a re-imported line, a retry, two operators).

Takes the CALLER’S connection: it must read under the same transaction (and the same Self::lock_settlement lock) as the clearance it guards. The caller relays the ambient org scope onto that tx first, so a decorated deployment’s row-level fence decides which clearances the SUM sees.

The settlement grain needs no extra filter: a settlement id is a globally unique UUID, so (matched_source_type, matched_source_id) already selects exactly one settlement’s clearances, wherever they were written.

pub async fn insert_clearance( &self, conn: &mut PgConnection, c: &NewClearanceRow<'_>, ) -> Result<(), Error>

Record a clearance against a settled document.

Takes the CALLER’S connection so the clearance and the line’s allocation watermark commit as one unit — and so the bound check above stays in the same transaction as this write. The caller relays the ambient org scope onto it — don’t re-bind here.

pub async fn insert_charge_clearance( &self, conn: &mut PgConnection, c: &NewChargeClearanceRow, ) -> Result<(), Error>

Record a bank charge as a clearance. Same caller-owned-tx contract as Self::insert_clearance.

Methods from Deref<Target = GenericCrudRepository<BankClearance, SoftDelete>>

pub fn pool(&self) -> &Pool<Postgres>

pub fn table_name(&self) -> &str

pub async fn create(&self, entity: &T) -> Result<T, Error>

where T: Serialize + Send + Sync,

Insert a new entity row and return the created row.

pub async fn bulk_create(&self, entities: &[T]) -> Result<Vec<T>, Error>

where T: Serialize + Send + Sync,

Insert multiple entity rows inside a single transaction.

pub async fn run_filtered_query( &self, pagination: PaginationParams, base_condition: Option<&str>, filters: &HashMap<String, String>, column_types: &HashMap<String, String>, search_fields: &[&str], ) -> Result<PaginatedResult<T>, Error>

where T: Send + Sync,

Execute a filtered / paginated query against this entity’s table.

base_condition — when Some, it is inserted as the __base_condition filter key which the ORM injects verbatim into the WHERE clause. Use this to add soft-delete guards without touching the caller-supplied filters.

NOTE: prefer the *_scoped entry points for anything a client can reach — they compose the company fence into this condition. This raw form applies no fence and is for internal/job callers that have already established scope.

pub async fn run_aggregate_query( &self, spec: &AggregateSpec, base_condition: Option<&str>, filters: &HashMap<String, String>, column_types: &HashMap<String, String>, search_fields: &[&str], ) -> Result<AggregateResult, Error>

where T: EntityRepoMeta + Send + Sync,

The aggregate twin of Self::run_filtered_query.

Takes the same base_condition so an aggregate is computed over exactly the row set the matching list would return — a total that counted soft-deleted rows, or another tenant’s, would be wrong in a way no caller could see.

pub async fn find_by_text_field( &self, field: &str, value: &str, ) -> Result<Option<T>, Error>

Find an active entity by a unique text field.

Filters metadata->>'deleted_at' IS NULL automatically.

pub async fn exists_by_text_field( &self, field: &str, value: &str, ) -> Result<bool, Error>

Check existence by a unique text field (active records only).

pub async fn find_by_uuid_field( &self, field: &str, value: Uuid, ) -> Result<Option<T>, Error>

Find an active entity by a unique UUID field.

pub async fn exists_by_uuid_field( &self, field: &str, value: Uuid, ) -> Result<bool, Error>

Check existence by a unique UUID field (active records only).

pub async fn list_paginated_filtered( &self, pagination: PaginationParams, filters: Option<&HashMap<String, String>>, ) -> Result<PaginatedResult<T>, Error>

where T: EntityRepoMeta + Send + Sync,

Paginate active entities with filter and search support.

Requires T: EntityRepoMeta for column type hints and search fields.

pub async fn aggregate_filtered( &self, spec: &AggregateSpec, filters: Option<&HashMap<String, String>>, ) -> Result<AggregateResult, Error>

where T: EntityRepoMeta + Send + Sync,

Group and reduce active entities, skipping the soft-deleted.

pub async fn list_paginated_filtered_scoped( &self, pagination: PaginationParams, filters: Option<&HashMap<String, String>>, company: Option<Uuid>, ) -> Result<PaginatedResult<T>, Error>

where T: EntityRepoMeta + Send + Sync,

Paginate active entities, fenced to company.

The company-scoped counterpart of Self::list_paginated_filtered and the one any client-reachable read should use. Fails closed: a fenced entity with no company returns MissingCompanyScope rather than every company’s rows.

The fence is ANDed into the same __base_condition the soft-delete guard uses, so it lands in SQL — which is what keeps total honest. A post-filter in the handler would fetch limit rows and return the survivors, leaving callers unable to tell “end of data” from “filtered”, and could not fix COUNT at all.

pub async fn list_deleted_filtered_scoped( &self, pagination: PaginationParams, filters: Option<&HashMap<String, String>>, company: Option<Uuid>, ) -> Result<PaginatedResult<T>, Error>

where T: EntityRepoMeta + Send + Sync,

Paginate soft-deleted entities, fenced to company.

/trash is the worse leak of the two: it serves rows whose owners were told the data is gone. Same fence, same fail-closed contract.

pub async fn list_deleted_filtered( &self, pagination: PaginationParams, filters: Option<&HashMap<String, String>>, ) -> Result<PaginatedResult<T>, Error>

where T: EntityRepoMeta + Send + Sync,

Paginate soft-deleted entities with filter support.

pub async fn find_by_id(&self, id: &str) -> Result<Option<T>, Error>

Find an active (non-deleted) entity by primary key.

pub async fn find_all(&self) -> Result<Vec<T>, Error>

Return all active (non-deleted) entities.

pub async fn update(&self, id: &str, entity: &T) -> Result<Option<T>, Error>

where T: Serialize + Send + Sync,

Full update — skips silently if the record is already soft-deleted.

pub async fn delete(&self, id: &str) -> Result<bool, Error>

Soft-delete an entity (sets metadata.deleted_at).

pub async fn count(&self) -> Result<u64, Error>

Count active (non-deleted) entities.

pub async fn exists(&self, id: &str) -> Result<bool, Error>

Return true if an active entity with the given ID exists.

pub async fn list_paginated( &self, pagination: PaginationParams, ) -> Result<PaginatedResult<T>, Error>

Paginate active entities (most-recent-first by ID).

pub async fn soft_delete(&self, id: &str) -> Result<bool, Error>

Set metadata.deleted_at to NOW() (soft delete).

pub async fn restore(&self, id: &str) -> Result<Option<T>, Error>

Remove deleted_at from metadata, restoring the entity.

pub async fn list_deleted( &self, pagination: PaginationParams, ) -> Result<PaginatedResult<T>, Error>

Paginate soft-deleted entities (trash view).

pub async fn empty_trash(&self) -> Result<u64, Error>

Permanently delete all soft-deleted rows (empty trash).

pub async fn find_deleted_by_id(&self, id: &str) -> Result<Option<T>, Error>

Find a soft-deleted entity by primary key.

pub async fn permanent_delete(&self, id: &str) -> Result<bool, Error>

Permanently delete a soft-deleted entity by primary key.

pub async fn count_active(&self) -> Result<u64, Error>

Count active (non-deleted) entities.

pub async fn count_deleted(&self) -> Result<u64, Error>

Count soft-deleted entities.

pub async fn bulk_soft_delete(&self, ids: &[String]) -> Result<u64, Error>

Soft-delete many active rows atomically.

pub async fn bulk_restore(&self, ids: &[String]) -> Result<Vec<T>, Error>

Restore many soft-deleted rows atomically, returning the restored rows.

pub async fn bulk_permanent_delete(&self, ids: &[String]) -> Result<u64, Error>

Permanently delete many soft-deleted rows atomically.

pub async fn restore_all(&self) -> Result<Vec<T>, Error>

Restore every soft-deleted row, returning the restored rows. A single UPDATE ... RETURNING is atomic, and the returned rows let the service layer emit a Restored event per entity.

pub async fn bulk_update(&self, entities: &[T]) -> Result<Vec<T>, Error>

where T: Serialize + Send + Sync,

Update many active rows atomically. Every entity must reference an existing active (non-soft-deleted) row or the whole batch is rolled back.

Trait Implementations

impl CrudRepository<BankClearance> for BankClearanceRepository

fn fetch_related_json<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, table: &'life1 str, ids: &'life2 [String], ) -> Pin<Box<dyn Future<Output = Vec<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Hydrate ?include= relations: fetch rows from table by id list, as JSON (raw row_to_json). table comes from EntityRepoMeta::relations() (generator-emitted), never client input. Default: no expansion. The Postgres-backed generated repos override this via impl_crud_repository!.

fn create<'life0, 'async_trait>( &'life0 self, entity: BankClearance, ) -> Pin<Box<dyn Future<Output = Result<BankClearance, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a new entity

fn find_by_id<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Find entity by ID (excluding soft-deleted)

fn find_by_id_including_deleted<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Find entity by ID (including soft-deleted, for trash operations)

fn update<'life0, 'async_trait>( &'life0 self, entity: BankClearance, ) -> Pin<Box<dyn Future<Output = Result<BankClearance, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update an existing entity

fn soft_delete<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Soft delete an entity

fn restore<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restore a soft-deleted entity

fn hard_delete<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Permanently delete an entity

fn list<'life0, 'async_trait>( &'life0 self, page: u32, limit: u32, ) -> Pin<Box<dyn Future<Output = Result<(Vec<BankClearance>, u64), RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List entities with pagination (excluding soft-deleted)

fn list_filtered<'life0, 'async_trait>( &'life0 self, page: u32, limit: u32, filters: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<(Vec<BankClearance>, u64), RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List entities with pagination and filters (excluding soft-deleted)

fn list_filtered_with_info<'life0, 'async_trait>( &'life0 self, page: u32, limit: u32, filters: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<(Vec<BankClearance>, PaginationInfo), RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

list_filtered, carrying the pagination info (cursor positions included) so the HTTP layer can surface keyset paging. Default: the tuple form with the cursor fields absent; the generated Postgres repositories override this with the real keyset walk.

fn table_name(&self) -> Option<&str>

Group and reduce entities under the same filters as list_filtered.

fn aggregate_filtered<'life0, 'life1, 'async_trait>( &'life0 self, spec: &'life1 AggregateSpec, filters: HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = Result<AggregateResult, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn list_deleted<'life0, 'async_trait>( &'life0 self, page: u32, limit: u32, ) -> Pin<Box<dyn Future<Output = Result<(Vec<BankClearance>, u64), RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List soft-deleted entities with pagination

fn count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Count all entities (excluding soft-deleted)

fn count_deleted<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Count soft-deleted entities

fn bulk_create<'life0, 'async_trait>( &'life0 self, entities: Vec<BankClearance>, ) -> Pin<Box<dyn Future<Output = Result<Vec<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Bulk create entities

fn empty_trash<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Permanently delete all soft-deleted entities

fn bulk_soft_delete<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<u64, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Soft-delete many entities by id. Returns the number affected.

fn bulk_restore<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<Vec<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restore many soft-deleted entities by id. Returns the restored entities.

fn bulk_hard_delete<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<u64, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Permanently delete many entities by id. Returns the number affected.

fn restore_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Restore every soft-deleted entity. Returns the restored entities.

fn bulk_update<'life0, 'async_trait>( &'life0 self, entities: Vec<BankClearance>, ) -> Pin<Box<dyn Future<Output = Result<Vec<BankClearance>, RepositoryError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update many entities atomically. Returns the updated entities.

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, RepositoryError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Check if an entity exists by ID

impl Deref for BankClearanceRepository

type Target = GenericCrudRepository<BankClearance>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.