kotlin.org.bson.codecs.kotlinx.BsonConfiguration.kt Maven / Gradle / Ivy
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 org.bson.codecs.kotlinx
/**
* Bson Configuration for serialization
*
* Usage example with codecs:
* ```
* val codec = KotlinSerializerCodec.create(mykClass, bsonConfiguration = BsonConfiguration(encodeDefaults = false))
* ```
*
* @property encodeDefaults encode default values, defaults to true
* @property explicitNulls encode null values, defaults to false
* @property classDiscriminator class discriminator to use when encoding polymorphic types
*/
public data class BsonConfiguration(
val encodeDefaults: Boolean = true,
val explicitNulls: Boolean = false,
val classDiscriminator: String = "_t",
)