MongoScala3Codec
API
Generated with
MongoScala3Codec/io.github.mbannour/io.github.mbannour.mongo.codecs/CodecProviderMacro

CodecProviderMacro

io.github.mbannour.mongo.codecs.CodecProviderMacro
object CodecProviderMacro

CodecProviderMacro is a utility object that provides inline macros for generating MongoDB CodecProvider instances for Scala case classes.

A CodecProvider wraps a generated Codec[T] so it can be plugged into the MongoDB driver’s CodecRegistry, allowing seamless serialization and deserialization of your domain models.

Two variants are supported:

  • createCodecProviderEncodeNone encodes None fields as BSON null.
  • createCodecProviderIgnoreNone omits None fields entirely from the document.

==Quick Start== In your case class companion: {{ import io.github.mbannour.mongo.codecs.CodecProviderMacro import org.bson.codecs.configuration.CodecRegistries import org.mongodb.scala.MongoClient

case class Person(name: String, age: Int, nickname: Option[String])

object Person: // Choose encode-or-ignore None private val provider = CodecProviderMacro.createCodecProviderEncodeNone[Person]

given registry: CodecRegistry = CodecRegistries.fromRegistries( MongoClient.DEFAULT_CODEC_REGISTRY, CodecRegistries.fromProviders(provider) ) end Person }}

Then attach this registry to your database: {{ val client = MongoClient("mongodb://localhost") val db = client.getDatabase("mydb").withCodecRegistry(summon) val coll = db.getCollectionPerson coll.insertOne(Person("Alice", 30, None)).toFuture() }}

Attributes

See also

CaseClassCodecGenerator.generateCodec for the underlying codec generator.

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

inline def createCodecProviderEncodeNone[T](using classTag: ClassTag[T], codecRegistry: CodecRegistry): CodecProvider

Creates a CodecProvider for type T that encodes None values as BSON null.

Creates a CodecProvider for type T that encodes None values as BSON null.

Type parameters

T

The case class type for which to generate the provider.

Value parameters

classTag

Runtime ClassTag for T (injected implicitly).

codecRegistry

The base CodecRegistry used for nested type lookups.

Attributes

Returns

A CodecProvider that will supply a BSON Codec[T] including None fields.

Example

{{ val provider = CodecProviderMacro.createCodecProviderEncodeNone[Person] }}

inline def createCodecProviderIgnoreNone[T](using classTag: ClassTag[T], codecRegistry: CodecRegistry): CodecProvider

Creates a CodecProvider for type T that ignores None values during serialization.

Creates a CodecProvider for type T that ignores None values during serialization.

Type parameters

T

The case class type for which to generate the provider.

Value parameters

classTag

Runtime ClassTag for T (injected implicitly).

codecRegistry

The base CodecRegistry used for nested type lookups (e.g., String, Int, other case classes).

Attributes

Returns

A CodecProvider that will supply a BSON Codec[T] omitting fields with None values.

Example

{{ val provider = CodecProviderMacro.createCodecProviderIgnoreNone[Person] }}

Generated with