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 // SliceCodecOptions represents all possible options for 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 SliceCodecOptions struct {
14 EncodeNilAsEmpty *bool // Specifies if a nil slice should encode as an empty array instead of null. Defaults to false.
15 }
16 17 // SliceCodec creates a new *SliceCodecOptions
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 SliceCodec() *SliceCodecOptions {
22 return &SliceCodecOptions{}
23 }
24 25 // SetEncodeNilAsEmpty specifies if a nil slice should encode as an empty array instead of null. Defaults to false.
26 //
27 // Deprecated: Use [go.mongodb.org/mongo-driver/bson.Encoder.NilSliceAsEmpty] instead.
28 func (s *SliceCodecOptions) SetEncodeNilAsEmpty(b bool) *SliceCodecOptions {
29 s.EncodeNilAsEmpty = &b
30 return s
31 }
32 33 // MergeSliceCodecOptions combines the given *SliceCodecOptions into a single *SliceCodecOptions 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 MergeSliceCodecOptions(opts ...*SliceCodecOptions) *SliceCodecOptions {
38 s := SliceCodec()
39 for _, opt := range opts {
40 if opt == nil {
41 continue
42 }
43 if opt.EncodeNilAsEmpty != nil {
44 s.EncodeNilAsEmpty = opt.EncodeNilAsEmpty
45 }
46 }
47 48 return s
49 }
50