115 lines
2.7 KiB
Go
115 lines
2.7 KiB
Go
// SPDX-FileCopyrightText: Copyright 2015-2025 go-swagger maintainers
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package strfmt
|
|
|
|
import (
|
|
"database/sql/driver"
|
|
"fmt"
|
|
|
|
bsonprim "go.mongodb.org/mongo-driver/bson/primitive"
|
|
)
|
|
|
|
func init() {
|
|
var id ObjectId
|
|
// register this format in the default registry
|
|
Default.Add("bsonobjectid", &id, IsBSONObjectID)
|
|
}
|
|
|
|
// IsBSONObjectID returns true when the string is a valid BSON.ObjectId
|
|
func IsBSONObjectID(str string) bool {
|
|
_, err := bsonprim.ObjectIDFromHex(str)
|
|
return err == nil
|
|
}
|
|
|
|
// ObjectId represents a BSON object ID (alias to go.mongodb.org/mongo-driver/bson/primitive.ObjectID)
|
|
//
|
|
// swagger:strfmt bsonobjectid
|
|
type ObjectId bsonprim.ObjectID //nolint:revive
|
|
|
|
// NewObjectId creates a ObjectId from a Hex String
|
|
func NewObjectId(hex string) ObjectId { //nolint:revive
|
|
oid, err := bsonprim.ObjectIDFromHex(hex)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return ObjectId(oid)
|
|
}
|
|
|
|
// MarshalText turns this instance into text
|
|
func (id ObjectId) MarshalText() ([]byte, error) {
|
|
oid := bsonprim.ObjectID(id)
|
|
if oid == bsonprim.NilObjectID {
|
|
return nil, nil
|
|
}
|
|
return []byte(oid.Hex()), nil
|
|
}
|
|
|
|
// UnmarshalText hydrates this instance from text
|
|
func (id *ObjectId) UnmarshalText(data []byte) error { // validation is performed later on
|
|
if len(data) == 0 {
|
|
*id = ObjectId(bsonprim.NilObjectID)
|
|
return nil
|
|
}
|
|
oidstr := string(data)
|
|
oid, err := bsonprim.ObjectIDFromHex(oidstr)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
*id = ObjectId(oid)
|
|
return nil
|
|
}
|
|
|
|
// Scan read a value from a database driver
|
|
func (id *ObjectId) Scan(raw any) error {
|
|
var data []byte
|
|
switch v := raw.(type) {
|
|
case []byte:
|
|
data = v
|
|
case string:
|
|
data = []byte(v)
|
|
default:
|
|
return fmt.Errorf("cannot sql.Scan() strfmt.URI from: %#v: %w", v, ErrFormat)
|
|
}
|
|
|
|
return id.UnmarshalText(data)
|
|
}
|
|
|
|
// Value converts a value to a database driver value
|
|
func (id ObjectId) Value() (driver.Value, error) {
|
|
return driver.Value(bsonprim.ObjectID(id).Hex()), nil
|
|
}
|
|
|
|
func (id ObjectId) String() string {
|
|
return bsonprim.ObjectID(id).Hex()
|
|
}
|
|
|
|
// MarshalJSON returns the ObjectId as JSON
|
|
func (id ObjectId) MarshalJSON() ([]byte, error) {
|
|
return bsonprim.ObjectID(id).MarshalJSON()
|
|
}
|
|
|
|
// UnmarshalJSON sets the ObjectId from JSON
|
|
func (id *ObjectId) UnmarshalJSON(data []byte) error {
|
|
var obj bsonprim.ObjectID
|
|
if err := obj.UnmarshalJSON(data); err != nil {
|
|
return err
|
|
}
|
|
*id = ObjectId(obj)
|
|
return nil
|
|
}
|
|
|
|
// DeepCopyInto copies the receiver and writes its value into out.
|
|
func (id *ObjectId) DeepCopyInto(out *ObjectId) {
|
|
*out = *id
|
|
}
|
|
|
|
// DeepCopy copies the receiver into a new ObjectId.
|
|
func (id *ObjectId) DeepCopy() *ObjectId {
|
|
if id == nil {
|
|
return nil
|
|
}
|
|
out := new(ObjectId)
|
|
id.DeepCopyInto(out)
|
|
return out
|
|
}
|