smithy4s.json.JsonPayloadCodecCompiler.scala Maven / Gradle / Ivy
/*
* Copyright 2021-2024 Disney Streaming
*
* Licensed under the Tomorrow Open Source Technology License, Version 1.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://disneystreaming.github.io/TOST-1.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package smithy4s.json
import smithy4s.schema.CachedSchemaCompiler
// scalafmt: {maxColumn = 120}
import com.github.plokhotnyuk.jsoniter_scala.core.{ReaderConfig => JsoniterReaderConfig}
import com.github.plokhotnyuk.jsoniter_scala.core.{WriterConfig => JsoniterWriterConfig}
import smithy4s.codecs.PayloadDecoder
import smithy4s.codecs.PayloadEncoder
trait JsonPayloadCodecCompiler {
/**
* Changes the jsoniter codec compiler that backs this compiler. This can be used
* to tweak the behaviour of Json encoding and decoding alike.
*/
def withJsoniterCodecCompiler(jsoniterCodecCompiler: JsoniterCodecCompiler): JsonPayloadCodecCompiler
/**
* Like withJsoniterCodecCompiler, but allows you to modify the current codec compiler more easily.
*/
def configureJsoniterCodecCompiler(
jsoniterCodecCompiler: JsoniterCodecCompiler => JsoniterCodecCompiler
): JsonPayloadCodecCompiler
/**
* Changes the jsoniter reader config that is used when parsing json payloads into data.
*/
def withJsoniterReaderConfig(jsoniterReaderConfig: JsoniterReaderConfig): JsonPayloadCodecCompiler
/**
* Changes the jsoniter writer config that is used when writing data into json.
*
* @param jsoniterWriterConfig
* @return
*/
def withJsoniterWriterConfig(jsoniterWriterConfig: JsoniterWriterConfig): JsonPayloadCodecCompiler
def decoders: CachedSchemaCompiler[PayloadDecoder]
def encoders: CachedSchemaCompiler[PayloadEncoder]
}