Scala SDK

The Scala library provides a full Twilic v2 implementation with dynamic, schema-aware, batch, and stateful encoding.

Requirements

• Java 21 or later
• Scala 3.3+
• sbt 1.10+

Install

sbt:

libraryDependencies += "io.twilic" %% "twilic" % "3.0.0"

Maven:

<dependency>
  <groupId>io.twilic</groupId>
  <artifactId>twilic_3</artifactId>
  <version>3.0.0</version>
</dependency>

Or clone and build from source:

git clone https://github.com/twilic/twilic-scala.git
cd twilic-scala && sbt test

Quick Start

import io.twilic.Twilic
import io.twilic.internal.core.*

val value = Twilic.newMap(
  Twilic.entry("id", Twilic.newU64(1001)),
  Twilic.entry("name", Twilic.newString("alice")),
  Twilic.entry("score", Twilic.newF64(98.6)),
)

val bytes = Twilic.encode(value)
val decoded = Twilic.decode(bytes)

println(Twilic.equal(decoded, value))

API Reference

Dynamic Encoding

Twilic.encode(value)   // Array[Byte]
Twilic.decode(bytes)   // Value

Schema-Aware Encoding

Twilic.encodeWithSchema(value, schema)

Batch Encoding

Twilic.encodeBatch(records)

Session Encoder

val enc = Twilic.newSessionEncoder()
enc.encode(value)
enc.reset()

The public package is io.twilic. Protocol core types live under io.twilic.internal.core (Java implementation shared with the reference SDK layout).

Project Layout

twilic-scala/
  src/main/scala/io/twilic/          # public Scala API
  src/main/java/io/twilic/internal/  # protocol core (Java)
  src/test/scala/                    # ScalaTest spec tests
  scripts/                           # Rust interop smoke checks

Source

github.com/twilic/twilic-scala