empty_interface_codec_options.go raw

   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  // EmptyInterfaceCodecOptions represents all possible options for interface{} 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 EmptyInterfaceCodecOptions struct {
  14  	DecodeBinaryAsSlice *bool // Specifies if Old and Generic type binarys should default to []slice instead of primitive.Binary. Defaults to false.
  15  }
  16  
  17  // EmptyInterfaceCodec creates a new *EmptyInterfaceCodecOptions
  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 EmptyInterfaceCodec() *EmptyInterfaceCodecOptions {
  22  	return &EmptyInterfaceCodecOptions{}
  23  }
  24  
  25  // SetDecodeBinaryAsSlice specifies if Old and Generic type binarys should default to []slice instead of primitive.Binary. Defaults to false.
  26  //
  27  // Deprecated: Use [go.mongodb.org/mongo-driver/bson.Decoder.BinaryAsSlice] instead.
  28  func (e *EmptyInterfaceCodecOptions) SetDecodeBinaryAsSlice(b bool) *EmptyInterfaceCodecOptions {
  29  	e.DecodeBinaryAsSlice = &b
  30  	return e
  31  }
  32  
  33  // MergeEmptyInterfaceCodecOptions combines the given *EmptyInterfaceCodecOptions into a single *EmptyInterfaceCodecOptions 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 MergeEmptyInterfaceCodecOptions(opts ...*EmptyInterfaceCodecOptions) *EmptyInterfaceCodecOptions {
  38  	e := EmptyInterfaceCodec()
  39  	for _, opt := range opts {
  40  		if opt == nil {
  41  			continue
  42  		}
  43  		if opt.DecodeBinaryAsSlice != nil {
  44  			e.DecodeBinaryAsSlice = opt.DecodeBinaryAsSlice
  45  		}
  46  	}
  47  
  48  	return e
  49  }
  50