Reference

API reference

Where the full type-level API lives, and a quick index of the public surface.

The authoritative, always-current API reference is generated from the source on docs.rs:

docs.rs/distkit - full signatures, trait bounds, and item-level docs.

This page is a map of where things live.

Module index

Path	Feature	Key items
`distkit`	-	`DistkitRedisKey`, `CounterComparator`, `DistkitError`
`distkit::counter`	`counter`	`CounterTrait`, `StrictCounter`, `LaxCounter`, `CounterOptions`
`distkit::icounter`	`instance-aware-counter`	`InstanceAwareCounterTrait`, `StrictInstanceAwareCounter`, `LaxInstanceAwareCounter` and their options
`distkit::lock`	`lock`	`Mutex`, `RwLock`, guards, `LockOptions`, `LockGuardState`, `LockError`
`distkit::trypema`	`trypema`	Re-export of the trypema crate

DistkitRedisKey - validated key wrapper. See Keys.
CounterComparator - Eq / Lt / Gt / Ne / Nil for conditional writes. See Comparators.
DistkitError - the one error type everything returns. See Errors.

Methods live on traits, so the relevant trait must be imported to call them:

Feature flags

Every distkit feature flag and what it pulls in.

Changelog

Notable changes to distkit, newest first.