func RangeEntries(es EntryRanger, less KeyOrder, fn VisitEntry)
RangeEntries iterates over the entries of es according to the specified order.
func RangeFields(fs FieldRanger, less FieldOrder, fn VisitField)
RangeFields iterates over the fields of fs according to the specified order.
EntryRanger is an interface for visiting all fields in a message. The protoreflect.Map type implements this interface.
type EntryRanger interface{ Range(VisitEntry) }
FieldOrder specifies the ordering to visit message fields. It is a function that reports whether x is ordered before y.
type FieldOrder func(x, y protoreflect.FieldDescriptor) bool
var (
// AnyFieldOrder specifies no specific field ordering.
AnyFieldOrder FieldOrder = nil
// LegacyFieldOrder sorts fields in the same ordering as emitted by
// wire serialization in the github.com/golang/protobuf implementation.
LegacyFieldOrder FieldOrder = func(x, y protoreflect.FieldDescriptor) bool {
ox, oy := x.ContainingOneof(), y.ContainingOneof()
inOneof := func(od protoreflect.OneofDescriptor) bool {
return od != nil && !od.IsSynthetic()
}
if x.IsExtension() != y.IsExtension() {
return x.IsExtension() && !y.IsExtension()
}
if inOneof(ox) != inOneof(oy) {
return !inOneof(ox) && inOneof(oy)
}
if inOneof(ox) && inOneof(oy) && ox != oy {
return ox.Index() < oy.Index()
}
return x.Number() < y.Number()
}
// NumberFieldOrder sorts fields by their field number.
NumberFieldOrder FieldOrder = func(x, y protoreflect.FieldDescriptor) bool {
return x.Number() < y.Number()
}
// IndexNameFieldOrder sorts non-extension fields before extension fields.
// Non-extensions are sorted according to their declaration index.
// Extensions are sorted according to their full name.
IndexNameFieldOrder FieldOrder = func(x, y protoreflect.FieldDescriptor) bool {
if x.IsExtension() != y.IsExtension() {
return !x.IsExtension() && y.IsExtension()
}
if x.IsExtension() && y.IsExtension() {
return x.FullName() < y.FullName()
}
return x.Index() < y.Index()
}
)
FieldRnger is an interface for visiting all fields in a message. The protoreflect.Message type implements this interface.
type FieldRanger interface{ Range(VisitField) }
KeyOrder specifies the ordering to visit map entries. It is a function that reports whether x is ordered before y.
type KeyOrder func(x, y protoreflect.MapKey) bool
var (
// AnyKeyOrder specifies no specific key ordering.
AnyKeyOrder KeyOrder = nil
// GenericKeyOrder sorts false before true, numeric keys in ascending order,
// and strings in lexicographical ordering according to UTF-8 codepoints.
GenericKeyOrder KeyOrder = func(x, y protoreflect.MapKey) bool {
switch x.Interface().(type) {
case bool:
return !x.Bool() && y.Bool()
case int32, int64:
return x.Int() < y.Int()
case uint32, uint64:
return x.Uint() < y.Uint()
case string:
return x.String() < y.String()
default:
panic("invalid map key type")
}
}
)
VisitEntry is called every time a map entry is visited.
type VisitEntry = func(protoreflect.MapKey, protoreflect.Value) bool
VisitField is called every time a message field is visited.
type VisitField = func(protoreflect.FieldDescriptor, protoreflect.Value) bool