github.com/mdaxf/iac@v0.0.0-20240519030858-58a061660378/vendor_skip/go.mongodb.org/mongo-driver/bson/bsonoptions/uint_codec_options.go (about)

     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  // UIntCodecOptions represents all possible options for uint 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 UIntCodecOptions struct {
    14  	EncodeToMinSize *bool // Specifies if all uints except uint64 should be decoded to minimum size bsontype. Defaults to false.
    15  }
    16  
    17  // UIntCodec creates a new *UIntCodecOptions
    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 UIntCodec() *UIntCodecOptions {
    22  	return &UIntCodecOptions{}
    23  }
    24  
    25  // SetEncodeToMinSize specifies if all uints except uint64 should be decoded to minimum size bsontype. Defaults to false.
    26  //
    27  // Deprecated: Use [go.mongodb.org/mongo-driver/bson.Encoder.IntMinSize] instead.
    28  func (u *UIntCodecOptions) SetEncodeToMinSize(b bool) *UIntCodecOptions {
    29  	u.EncodeToMinSize = &b
    30  	return u
    31  }
    32  
    33  // MergeUIntCodecOptions combines the given *UIntCodecOptions into a single *UIntCodecOptions 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 MergeUIntCodecOptions(opts ...*UIntCodecOptions) *UIntCodecOptions {
    38  	u := UIntCodec()
    39  	for _, opt := range opts {
    40  		if opt == nil {
    41  			continue
    42  		}
    43  		if opt.EncodeToMinSize != nil {
    44  			u.EncodeToMinSize = opt.EncodeToMinSize
    45  		}
    46  	}
    47  
    48  	return u
    49  }