oxygen-json
API
Generated with
oxygen-json/oxygen/oxygen.json/JsonCodec

JsonCodec

oxygen.json.JsonCodec
See theJsonCodec companion class
object JsonCodec extends LowPriority1

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
trait LowPriority1
class Object
trait Matchable
class Any
Show all
Self type
JsonCodec.type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

inline def apply[A](using ev: JsonCodec[A]): JsonCodec[A]
inline def deriveWrapped[A]: JsonCodec[A]

Expects A to be a case class with a single field. Will then derive an instance

Expects A to be a case class with a single field. Will then derive an instance

Example:

final case class Wrapped(value: String)
object Wrapped {
 given JsonCodec[Wrapped] = JsonCodec.deriveWrapped
}

Attributes

inline def derived[A]: JsonCodec[A]
def enum[A : StrictEnum]: JsonCodec[A]

Givens

Givens

given arraySeq[A](using encoder: JsonCodec[A]): JsonCodec[ArraySeq[A]]
given bigDecimal: JsonCodec[BigDecimal]
given bigInt: JsonCodec[BigInt]
given boolean: JsonCodec[Boolean]
given byte: JsonCodec[Byte]
given double: JsonCodec[Double]
given duration: JsonCodec[Duration]
given enumWithOther[A : EnumWithOther]: JsonCodec[A]
given float: JsonCodec[Float]
given instant: JsonCodec[Instant]
given int: JsonCodec[Int]
given json: JsonCodec[Json]
given jsonNull: JsonCodec[Null.type]
given localDate: JsonCodec[LocalDate]
given localDateTime: JsonCodec[LocalDateTime]
given localTime: JsonCodec[LocalTime]
given long: JsonCodec[Long]
given map[K : JsonFieldDecoder, V : JsonCodec]: JsonCodec[Map[K, V]]
given month: JsonCodec[Month]
given monthDay: JsonCodec[MonthDay]
given offsetDateTime: JsonCodec[OffsetDateTime]
given offsetTime: JsonCodec[OffsetTime]
given option[A : JsonCodec]: JsonCodec[Option[A]]
given period: JsonCodec[Period]
given seq[S[_] : SeqOps, A : JsonCodec]: JsonCodec[S[A]]
given short: JsonCodec[Short]
given specified[A : JsonCodec]: JsonCodec[Specified[A]]
given strictEnum[A : StrictEnum]: JsonCodec[A]
given string: JsonCodec[String]
given timeZone: JsonCodec[TimeZone]
given tuple[A <: Tuple : TupleDecoder]: JsonCodec[A]
given uuid: JsonCodec[UUID]
given year: JsonCodec[Year]
given yearMonth: JsonCodec[YearMonth]
given zoneId: JsonCodec[ZoneId]
given zoneOffset: JsonCodec[ZoneOffset]
given zonedDateTime: JsonCodec[ZonedDateTime]

Inherited givens

given fromEncoderAndDecoder[A](using enc: JsonEncoder[A], dec: JsonDecoder[A]): JsonCodec[A]

Attributes

Inherited from:
LowPriority1
Generated with