blob: a12ec9791cbb810485f11a33c2795795ccb59916 [file] [log] [blame]
Abhay Kumara2ae5992025-11-10 14:02:24 +00001// Copyright 2025 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
5package filedesc
6
7import "google.golang.org/protobuf/reflect/protoreflect"
8
9// UsePresenceForField reports whether the presence bitmap should be used for
10// the specified field.
11func UsePresenceForField(fd protoreflect.FieldDescriptor) (usePresence, canBeLazy bool) {
12 switch {
13 case fd.ContainingOneof() != nil && !fd.ContainingOneof().IsSynthetic():
14 // Oneof fields never use the presence bitmap.
15 //
16 // Synthetic oneofs are an exception: Those are used to implement proto3
17 // optional fields and hence should follow non-oneof field semantics.
18 return false, false
19
20 case fd.IsMap():
21 // Map-typed fields never use the presence bitmap.
22 return false, false
23
24 case fd.Kind() == protoreflect.MessageKind || fd.Kind() == protoreflect.GroupKind:
25 // Lazy fields always use the presence bitmap (only messages can be lazy).
26 isLazy := fd.(interface{ IsLazy() bool }).IsLazy()
27 return isLazy, isLazy
28
29 default:
30 // If the field has presence, use the presence bitmap.
31 return fd.HasPresence(), false
32 }
33}