Getting Started

Modules

borer consists of these modules:

• borer-core, the actual core logic (no dependencies)
• borer-derivation, (semi-)automatic codec derivation for case classes and ADTs
  (no dependencies, relies on macros)
• borer-compat-akka, support for akka.util.ByteString and akka-http (un)marshalling
  (has a provided dependency on akka-actor, akka-stream and akka-http)
• borer-compat-pekko, support for pekko.util.ByteString and pekko-http (un)marshalling
  (has a provided dependency on pekko-actor, pekko-stream and pekko-http)
• borer-compat-cats, support for popular cats data structures from the cats.data._ package (has a provided dependency on cats-core)
• borer-compat-circe, seamless integration with circe codecs
  (has a provided dependency on circe)
• borer-compat-scodec, support for scodec.bits.ByteVector
  (has a provided dependency on scodec)

Installation

The artifacts for borer live on Maven Central and can be tied into your project like this:

sbt

libraryDependencies ++= Seq(
  "io.bullet" %% "borer-core" % "1.14.0",
  "io.bullet" %% "borer-derivation" % "1.14.0",
  "io.bullet" %% "borer-compat-akka" % "1.14.0",
  "io.bullet" %% "borer-compat-circe" % "1.14.0",
  "io.bullet" %% "borer-compat-scodec" % "1.14.0"
)

Maven

<dependencies>
  <dependency>
    <groupId>io.bullet</groupId>
    <artifactId>borer-core_3</artifactId>
    <version>1.14.0</version>
  </dependency>
  <dependency>
    <groupId>io.bullet</groupId>
    <artifactId>borer-derivation_3</artifactId>
    <version>1.14.0</version>
  </dependency>
  <dependency>
    <groupId>io.bullet</groupId>
    <artifactId>borer-compat-akka_3</artifactId>
    <version>1.14.0</version>
  </dependency>
  <dependency>
    <groupId>io.bullet</groupId>
    <artifactId>borer-compat-circe_3</artifactId>
    <version>1.14.0</version>
  </dependency>
  <dependency>
    <groupId>io.bullet</groupId>
    <artifactId>borer-compat-scodec_3</artifactId>
    <version>1.14.0</version>
  </dependency>
</dependencies>

Gradle

dependencies {
  implementation "io.bullet:borer-core_3:1.14.0"
  implementation "io.bullet:borer-derivation_3:1.14.0"
  implementation "io.bullet:borer-compat-akka_3:1.14.0"
  implementation "io.bullet:borer-compat-circe_3:1.14.0"
  implementation "io.bullet:borer-compat-scodec_3:1.14.0"
}

The current borer is available for Scala 3.x only, both for the JVM as well as scala.js.

The latest version supporting Scala 2.13 is 1.8.0.
The latest version supporting Scala 2.12 is 1.7.2.