---

This section details on the original issue you should resolve

<issue_title>Create a new MongoDB method IsZero similar to IsNull to support omitzero tag</issue_title>
<issue_description>### Welcome

• Yes, I've searched similar issues on GitHub and didn't find any.

Detailed Description

I need a new MongoDB-specific method to be created, called IsZero, similar to the existing IsNull method, to support the MongoDB omitzero tag functionality. This would enable proper handling of zero values in MongoDB operations when using the omitzero tag in struct fields.

This is specifically for MongoDB driver functionality, not for the Go standard library's omitzero implementation.</issue_description>

<agent_instructions>Add a IsZero function to the UUID type that returns true if the value of the UUID is equal to zero. This should work identically to the existing IsNil function.

The end goal of this capability is to conform to the bsoncodec Zeroer interface, which is documented here https://pkg.go.dev/go.mongodb.org/mongo-driver/bson/bsoncodec#Zeroer</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@dylan-bourque This shouldn't be necessary since [uuid.Nil](https://github.com/gofrs/uuid/blob/master/uuid.go#L159) is already a zero value of the `UUID` type.

From the docs for encoding/json/v2:

When marshaling, the "omitzero" option specifies that the struct field should be omitted if the field value is zero as determined by the "IsZero() bool" method if present, otherwise based on whether the field is the zero Go value.

The 2nd case (emphasis added) would apply.

@dylan-bourque Right, but it's not necessary to have an explicit `IsZero()` method for the `omitzero` tag to work. If that method doesn't exist, then the value is omitted if the value is a zero value.

From the 1.24 release notes that you linked:

If the field type has an IsZero() bool method, that will be used to determine whether the value is zero. Otherwise, the value is zero if it is the zero value for its type.

In this case, adding the method isn't required since uuid.Nil is a zero value of the UUID type.</comment_new>
<comment_new>@dylan-bourque
Ah. Supporting a specific MongoDB feature is very different than supporting things defined in the Go standard library. Can you please update the description and title to reflect that this request is for MongoDB and not omitzero as defined by the standard library?

FWIW, I would personally argue that bsoncodec should be updated to behave like the standard library. 🤷‍♂️ </comment_new>
<comment_new>@cameracker
I'll get to this eventually but I'm a little strapped for time. I'm sort of curious what copilot will do if I give it a very specific prompt so might mess around with that (at risk of incurring the rage of anti AI folks 😅 )</comment_new>