1 // Copyright (C) MongoDB, Inc. 2017-present.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may
4 // not use this file except in compliance with the License. You may obtain
5 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
6 7 package bsonoptions
8 9 // ByteSliceCodecOptions represents all possible options for byte slice encoding and decoding.
10 //
11 // Deprecated: Use the bson.Encoder and bson.Decoder configuration methods to set the desired BSON marshal
12 // and unmarshal behavior instead.
13 type ByteSliceCodecOptions struct {
14 EncodeNilAsEmpty *bool // Specifies if a nil byte slice should encode as an empty binary instead of null. Defaults to false.
15 }
16 17 // ByteSliceCodec creates a new *ByteSliceCodecOptions
18 //
19 // Deprecated: Use the bson.Encoder and bson.Decoder configuration methods to set the desired BSON marshal
20 // and unmarshal behavior instead.
21 func ByteSliceCodec() *ByteSliceCodecOptions {
22 return &ByteSliceCodecOptions{}
23 }
24 25 // SetEncodeNilAsEmpty specifies if a nil byte slice should encode as an empty binary instead of null. Defaults to false.
26 //
27 // Deprecated: Use [go.mongodb.org/mongo-driver/bson.Encoder.NilByteSliceAsEmpty] instead.
28 func (bs *ByteSliceCodecOptions) SetEncodeNilAsEmpty(b bool) *ByteSliceCodecOptions {
29 bs.EncodeNilAsEmpty = &b
30 return bs
31 }
32 33 // MergeByteSliceCodecOptions combines the given *ByteSliceCodecOptions into a single *ByteSliceCodecOptions in a last one wins fashion.
34 //
35 // Deprecated: Merging options structs will not be supported in Go Driver 2.0. Users should create a
36 // single options struct instead.
37 func MergeByteSliceCodecOptions(opts ...*ByteSliceCodecOptions) *ByteSliceCodecOptions {
38 bs := ByteSliceCodec()
39 for _, opt := range opts {
40 if opt == nil {
41 continue
42 }
43 if opt.EncodeNilAsEmpty != nil {
44 bs.EncodeNilAsEmpty = opt.EncodeNilAsEmpty
45 }
46 }
47 48 return bs
49 }
50