53 lines
1.9 KiB
Go
53 lines
1.9 KiB
Go
// Copyright (C) MongoDB, Inc. 2017-present.
|
|
//
|
|
// 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
|
|
|
|
package bsonoptions
|
|
|
|
var defaultDecodeOIDAsHex = true
|
|
|
|
// StringCodecOptions represents all possible options for string encoding and decoding.
|
|
//
|
|
// Deprecated: Use the bson.Encoder and bson.Decoder configuration methods to set the desired BSON marshal
|
|
// and unmarshal behavior instead.
|
|
type StringCodecOptions struct {
|
|
DecodeObjectIDAsHex *bool // Specifies if we should decode ObjectID as the hex value. Defaults to true.
|
|
}
|
|
|
|
// StringCodec creates a new *StringCodecOptions
|
|
//
|
|
// Deprecated: Use the bson.Encoder and bson.Decoder configuration methods to set the desired BSON marshal
|
|
// and unmarshal behavior instead.
|
|
func StringCodec() *StringCodecOptions {
|
|
return &StringCodecOptions{}
|
|
}
|
|
|
|
// SetDecodeObjectIDAsHex specifies if object IDs should be decoded as their hex representation. If false, a string made
|
|
// from the raw object ID bytes will be used. Defaults to true.
|
|
//
|
|
// Deprecated: Decoding object IDs as raw bytes will not be supported in Go Driver 2.0.
|
|
func (t *StringCodecOptions) SetDecodeObjectIDAsHex(b bool) *StringCodecOptions {
|
|
t.DecodeObjectIDAsHex = &b
|
|
return t
|
|
}
|
|
|
|
// MergeStringCodecOptions combines the given *StringCodecOptions into a single *StringCodecOptions in a last one wins fashion.
|
|
//
|
|
// Deprecated: Merging options structs will not be supported in Go Driver 2.0. Users should create a
|
|
// single options struct instead.
|
|
func MergeStringCodecOptions(opts ...*StringCodecOptions) *StringCodecOptions {
|
|
s := &StringCodecOptions{&defaultDecodeOIDAsHex}
|
|
for _, opt := range opts {
|
|
if opt == nil {
|
|
continue
|
|
}
|
|
if opt.DecodeObjectIDAsHex != nil {
|
|
s.DecodeObjectIDAsHex = opt.DecodeObjectIDAsHex
|
|
}
|
|
}
|
|
|
|
return s
|
|
}
|