protocol

Type Members

1. macro class in extends Annotation with StaticAnnotation

   

   materialize Reads for the class

   materialize Reads for the class

   Annotations

   @compileTimeOnly( ... )

2. macro class io extends Annotation with StaticAnnotation

   

   materialize both Reads and Writes for the class

   materialize both Reads and Writes for the class

   Annotations

   @compileTimeOnly( ... )

3. macro class out extends Annotation with StaticAnnotation

   

   materialize Writes for the class

   materialize Writes for the class

   Annotations

   @compileTimeOnly( ... )

4. class removeNulls extends Annotation with StaticAnnotation

   

   Default Play's behavior for Options is that when the value is None then it does not appear in the resulting JSON.

   Default Play's behavior for Options is that when the value is None then it does not appear in the resulting JSON. We consider returning null a better choice, however it should allow enabling the default behavior and remove the value when it is None.

   To enable the same behavior as Play uses, annotate your ContextualJson instance with this annotation. When the macro detects this annotation, it removes all optional null values from the JSON.

   Example:

   // this produces nulls when there is none None
   object SimpleJson extends ContextualJson

   // this removes the pair when there is none None as a value
   @removeNulls
   object SimpleJson extends ContextualJson

5. class strict extends Annotation with StaticAnnotation

   

   if the object has a single field and is not @strict, it is transformed into a value.

   if the object has a single field and is not @strict, it is transformed into a value. With strict it is still an object

   Non-strict example

   @protocol.io case class Foo( value: String )

   Foo( "something" ) transformed to JSON produces JsString( "something" )

   Strict example

   @protocol.io @protocol.strict case class Foo( value: String )

   Foo( "something" ) transformed to JSON produces {"value":"something"}