Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package circe

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    Overview

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    The library is divided into a number of modules that either provide core functionality, support additional features via third-party dependencies, or facilitate integration with other libraries or frameworks.

    • numbers: core facilities for representing and parsing JSON numbers.
    • core: our JSON abstract syntax tree, our zipper-like cursor types, and our encoding and decoding type classes (and instances).
    • parser: JSON parsing support for both the Java Virtual Machine (using Jawn) and Scala.js (using the native JavaScript JSON parser).
    • testing: ScalaCheck Arbitrary instances for circe's JSON AST and other types, as well as other useful testing tools.
    • literal: JSON string interpolation and encoder and decoder instances for literal types.
    • generic: Shapeless-powered generic derivation for case classes and sealed trait hierarchies.
    • generic-extras: additional experimental generic derivation functionality (including some configurability).
    • pointer: A JSON Pointer implementation
    • pointer-literal: JSON Pointer string interpolation
    • shapes: encoders and decoders for Shapeless hlists, coproducts, records, and sized collections.
    • scodec: encoders and decoders for Scodec's BitVector and ByteVector.
    • refined: encoders and decoders for refined types.
    • spray: Spray marshaller conversions for Circe's type classes.

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    io
  • package syntax

    This package provides syntax via enrichment classes.

    This package provides syntax via enrichment classes.

    Definition Classes
    circe
  • EncoderOps
  • KeyOps

implicit final class KeyOps[K] extends AnyVal

Source
package.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyOps
  2. AnyVal
  3. Any
Implicitly
  1. by EncoderOps
  2. by EncoderOps
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new KeyOps(value: K)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toany2stringadd[KeyOps[K]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (KeyOps[K], B)
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toArrowAssoc[KeyOps[K]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def :=[A](a: A)(implicit arg0: Encoder[A], keyEncoder: KeyEncoder[K]): (String, Json)
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def ensuring(cond: (KeyOps[K]) => Boolean, msg: => Any): KeyOps[K]
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEnsuring[KeyOps[K]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (KeyOps[K]) => Boolean): KeyOps[K]
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEnsuring[KeyOps[K]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): KeyOps[K]
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEnsuring[KeyOps[K]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): KeyOps[K]
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEnsuring[KeyOps[K]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toStringFormat[KeyOps[K]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  13. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def toString(): String
    Definition Classes
    Any

Shadowed Implicit Value Members

  1. final def asJson(implicit encoder: Encoder[KeyOps[K]]): Json
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEncoderOps[KeyOps[K]] performed by method EncoderOps in io.circe.syntax.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (keyOps: EncoderOps[KeyOps[K]]).asJson(encoder)
    Definition Classes
    EncoderOps
  2. final def asJson(implicit encoder: Encoder[KeyOps[K]]): Json
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEncoderOps[KeyOps[K]] performed by method EncoderOps in io.circe.syntax.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (keyOps: EncoderOps[KeyOps[K]]).asJson(encoder)
    Definition Classes
    EncoderOps
  3. final def asJsonObject(implicit encoder: AsObject[KeyOps[K]]): JsonObject
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEncoderOps[KeyOps[K]] performed by method EncoderOps in io.circe.syntax.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (keyOps: EncoderOps[KeyOps[K]]).asJsonObject(encoder)
    Definition Classes
    EncoderOps
  4. final def asJsonObject(implicit encoder: AsObject[KeyOps[K]]): JsonObject
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toEncoderOps[KeyOps[K]] performed by method EncoderOps in io.circe.syntax.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (keyOps: EncoderOps[KeyOps[K]]).asJsonObject(encoder)
    Definition Classes
    EncoderOps

Deprecated Value Members

  1. def →[B](y: B): (KeyOps[K], B)
    Implicit
    This member is added by an implicit conversion from KeyOps[K] toArrowAssoc[KeyOps[K]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyVal

Inherited from Any

Inherited by implicit conversion EncoderOps fromKeyOps[K] to EncoderOps[KeyOps[K]]

Inherited by implicit conversion EncoderOps fromKeyOps[K] to EncoderOps[KeyOps[K]]

Inherited by implicit conversion any2stringadd fromKeyOps[K] to any2stringadd[KeyOps[K]]

Inherited by implicit conversion StringFormat fromKeyOps[K] to StringFormat[KeyOps[K]]

Inherited by implicit conversion Ensuring fromKeyOps[K] to Ensuring[KeyOps[K]]

Inherited by implicit conversion ArrowAssoc fromKeyOps[K] to ArrowAssoc[KeyOps[K]]

Ungrouped