Skip to main content

PayrollModule

Struct PayrollModule 

Source
pub struct PayrollModule { /* private fields */ }
Expand description

Payroll module configuration

Use the builder pattern to configure and register this module:

let payroll = PayrollModule::builder()
    .with_database(pool.clone())
    .build()?;

// Unguarded full CRUD (trusted/admin); compose a guarded router for production.
let router = payroll.all_crud_routes();

Implementations§

Source§

impl PayrollModule

Source

pub fn builder() -> PayrollModuleBuilder

Create a new module builder

Source

pub fn all_crud_routes(&self) -> Router

Mount ALL generated CRUD endpoints (12 per entity) with NO domain validation — the fully unguarded surface. A well-formed request can create invalid rows or soft-delete a referenced master out from under its dependents. Prefer a guarded composition (read + validated writes) for any real deployment; use this only in trusted/admin/seeding contexts.

Source

pub fn routes(&self) -> Router

👎Deprecated:

mounts unvalidated generic CRUD; prefer readonly_routes() + validated writes, or all_crud_routes() for the full/unguarded surface

Deprecated alias for Self::all_crud_routes. routes() reads like “the routes” but mounts UNVALIDATED generic CRUD on every entity — a naive mount exposes unguarded writes. Compose a guarded router (read + validated writes) for production, or call all_crud_routes() to opt into the full unguarded surface explicitly.

Source

pub fn readonly_routes(&self) -> Router

Read-only routes for every entity (GET endpoints only) — the safe base.

Generic mutation can’t reach here, so this surface cannot bypass a validated write service’s invariants. Use this as the production base and merge validated write routes (or a write service’s HTTP layer) onto it.

Source

pub fn payroll_write_service(&self) -> Arc<PayrollWriteService> ⓘ

The module-held validated write service (run verbs, computed slips, seams).

Source

pub fn with_payroll_write_service(self, svc: Arc<PayrollWriteService>) -> Self

Replace the write service at the composition root — the way a host wires real adapters over the fail-closed seams (e.g. staging domain events into an outbox) or swaps the pool-default input ports for adapters over the attendance/employee exports. Consuming self keeps the builder chain reading naturally:

let payroll = PayrollModule::builder()
    .with_database(pool.clone())
    .build()?
    .with_payroll_write_service(Arc::new(
        PayrollWriteService::new(pool.clone()).with_event_sink(my_outbox_sink),
    ));

Call before mounting routes; the module is consumed once at startup.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more