karpal-std 0.5.0

Standard prelude re-exports for the Karpal ecosystem
Documentation

karpal-std

Standard prelude for the Karpal ecosystem.

Re-exports the most commonly used types and traits from all Karpal crates for ergonomic single-import usage.

Usage

use karpal_std::prelude::*;

This gives you access to:

  • HKT encoding: HKT, HKT2, OptionF, ResultF, VecF, ResultBF, TupleF, and more
  • Functor hierarchy: Functor, Apply, Applicative, Chain, Monad, Alt, Plus, Alternative, Foldable, Traversable, FunctorFilter, Selective, Bifunctor, Contravariant, NaturalTransformation
  • Comonad hierarchy: Comonad, ComonadEnv, ComonadStore, ComonadTraced, Extend
  • Algebraic typeclasses: Semigroup, Monoid
  • Newtype wrappers: Sum, Product, Min, Max, First, Last
  • Abstract algebra: Group, AbelianGroup, Semiring, Ring, Field, Lattice, BoundedLattice, Module, VectorSpace
  • Adjunctions: Adjunction, ComposeF, End, Coend, DinaturalTransformation
  • Effect system: FunctorSt, ApplicativeSt, ChainSt, MonadTrans, ExceptTF, WriterTF, ReaderTF, StateTF
  • Proof system: Proven, Property, Rewrite, NonEmpty, Positive, and law-verification derive macros
  • External verification: Obligation, ObligationBundle, Term, Sort, Certificate, Certified, SmtLib2, Lean4, artifact layouts, configs, dry-run invocation plans, runner abstractions, backend policies, execution results, parsed SMT output, orchestration helpers, and verification reports
  • Optional amari-flynn bridge (karpal-std feature amari): statistical rare-event verification helpers, amari SMT obligation adapters, and probabilistic contract macros
  • Diagramming: Tensor, Braiding, Symmetry, Diagram, TextRenderer, and SvgRenderer for monoidal composition and string-diagram rendering
  • Profunctor: Profunctor, Strong, Choice, Traversing, FnP, ForgetF, TaggedF
  • Optics: Iso, Lens, Prism, Traversal, Fold, Getter, Setter, Review, and composed variants
  • Arrow hierarchy: Semigroupoid, Category, Arrow, ArrowChoice, ArrowApply, ArrowLoop, ArrowZero, ArrowPlus, FnA, KleisliF, CokleisliF
  • Free constructions: Free, Cofree, Freer, Coyoneda, Yoneda, Day, FreeAp, FreeAlt, Codensity, Density, Lan, Ran
  • Recursion schemes: Fix, Mu, Nu, cata, ana, hylo, para, apo, histo, futu, zygo, chrono
  • Macros: do_!, ado_!

For qualified access, the individual crates are also re-exported:

use karpal_std::karpal_core;
use karpal_std::karpal_profunctor;
use karpal_std::karpal_optics;
use karpal_std::karpal_arrow;
use karpal_std::karpal_free;
use karpal_std::karpal_recursion;
use karpal_std::karpal_algebra;
use karpal_std::karpal_effect;
use karpal_std::karpal_proof;
use karpal_std::karpal_verify;
use karpal_std::karpal_diagram;

The do_! and ado_! macros are available directly:

use karpal_std::do_;
use karpal_std::ado_;

License

AGPL-3.0-or-later