Packages

  • package root
    Definition Classes
    root
  • package co
    Definition Classes
    root
  • package topl
    Definition Classes
    co
  • package utils
    Definition Classes
    topl
  • package actors
    Definition Classes
    utils
  • package codecs
    Definition Classes
    utils
  • package encode
    Definition Classes
    utils
  • package exceptions
    Definition Classes
    utils
  • package mongodb

    Package containing codecs, typeclasses, and models for reading and writing data to Mongo DB.

    Package containing codecs, typeclasses, and models for reading and writing data to Mongo DB.

    Definition Classes
    utils
    Example:

    1. import co.topl.utils.mongodb.codecs._
import co.topl.utils.mongodb.implicits._

// converting to document
val assetCode: AssetCode = ???
val assetCodeDataModel = AssetCodeDataModel(assetCode)
val assetCodeDocument = assetCodeDataModel.asDocument

// converting from a document
val document = Document('{ "assetCodeVersion": 1, "issuer": "some address", "shortName": "my asset" }')
val model =
  DocumentDecoder[AssetCodeDataModel].fromDocument(document) // Either[String, AssetCodeDataModel]

println(model)
// AssetCodeDataModel(assetCodeVersion: 1, issuer: "some address", shortName: "my asset")
  • package models
  • Codecs
  • DocumentDecoder
  • DocumentEncoder
  • Implicits
  • codecs
  • implicits
  • package serialization
    Definition Classes
    utils
p

co.topl.utils

mongodb

package mongodb

Package containing codecs, typeclasses, and models for reading and writing data to Mongo DB.

Example:

  1. import co.topl.utils.mongodb.codecs._
import co.topl.utils.mongodb.implicits._

// converting to document
val assetCode: AssetCode = ???
val assetCodeDataModel = AssetCodeDataModel(assetCode)
val assetCodeDocument = assetCodeDataModel.asDocument

// converting from a document
val document = Document('{ "assetCodeVersion": 1, "issuer": "some address", "shortName": "my asset" }')
val model =
  DocumentDecoder[AssetCodeDataModel].fromDocument(document) // Either[String, AssetCodeDataModel]

println(model)
// AssetCodeDataModel(assetCodeVersion: 1, issuer: "some address", shortName: "my asset")
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. mongodb
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package models

Type Members

  1. trait Codecs extends AnyRef
  2. trait DocumentDecoder[T] extends Serializable
    Annotations
    @implicitNotFound()
  3. trait DocumentEncoder[T] extends Serializable
    Annotations
    @implicitNotFound()
  4. trait Implicits extends ToDocumentDecoderOps with ToDocumentEncoderOps

Value Members

  1. object DocumentDecoder extends Serializable
  2. object DocumentEncoder extends Serializable
  3. object codecs extends Codecs
  4. object implicits extends Implicits

Inherited from AnyRef

Inherited from Any

Ungrouped