Package: google.golang.org/protobuf/types/known/structpb

package structpb Import Path google.golang.org/protobuf/types/known/structpb (on go.dev) Dependency Relation imports 10 packages, and imported by one package

Involved Source Files d struct.pb.go Package structpb contains generated types for google/protobuf/struct.proto. The messages (i.e., Value, Struct, and ListValue) defined in struct.proto are used to represent arbitrary JSON. The Value message represents a JSON value, the Struct message represents a JSON object, and the ListValue message represents a JSON array. See https://json.org for more information. The Value, Struct, and ListValue types have generated MarshalJSON and UnmarshalJSON methods such that they serialize JSON equivalent to what the messages themselves represent. Use of these types with the "google.golang.org/protobuf/encoding/protojson" package ensures that they will be serialized as their JSON equivalent. # Conversion to and from a Go interface The standard Go "encoding/json" package has functionality to serialize arbitrary types to a large degree. The Value.AsInterface, Struct.AsMap, and ListValue.AsSlice methods can convert the protobuf message representation into a form represented by any, map[string]any, and []any. This form can be used with other packages that operate on such data structures and also directly with the standard json package. In order to convert the any, map[string]any, and []any forms back as Value, Struct, and ListValue messages, use the NewStruct, NewList, and NewValue constructor functions. # Example usage Consider the following example JSON object: { "firstName": "John", "lastName": "Smith", "isAlive": true, "age": 27, "address": { "streetAddress": "21 2nd Street", "city": "New York", "state": "NY", "postalCode": "10021-3100" }, "phoneNumbers": [ { "type": "home", "number": "212 555-1234" }, { "type": "office", "number": "646 555-4567" } ], "children": [], "spouse": null } To construct a Value message representing the above JSON object: m, err := structpb.NewValue(map[string]any{ "firstName": "John", "lastName": "Smith", "isAlive": true, "age": 27, "address": map[string]any{ "streetAddress": "21 2nd Street", "city": "New York", "state": "NY", "postalCode": "10021-3100", }, "phoneNumbers": []any{ map[string]any{ "type": "home", "number": "212 555-1234", }, map[string]any{ "type": "office", "number": "646 555-4567", }, }, "children": []any{}, "spouse": nil, }) if err != nil { ... // handle error } ... // make use of m as a *structpb.Value

Package-Level Functions (total 9)

func NewBoolValue(v bool) *Value NewBoolValue constructs a new boolean Value.

func NewList(v []any) (*ListValue, error) NewList constructs a ListValue from a general-purpose Go slice. The slice elements are converted using NewValue.

func NewListValue(v *ListValue) *Value NewListValue constructs a new list Value.

func NewNullValue() *Value NewNullValue constructs a new null Value.

func NewNumberValue(v float64) *Value NewNumberValue constructs a new number Value.

func NewStringValue(v string) *Value NewStringValue constructs a new string Value.

func NewStruct(v map[string]any) (*Struct, error) NewStruct constructs a Struct from a general-purpose Go map. The map keys must be valid UTF-8. The map values are converted using NewValue.

func NewStructValue(v *Struct) *Value NewStructValue constructs a new struct Value.

func NewValue(v any) (*Value, error) NewValue constructs a Value from a general-purpose Go interface. ╔═══════════════════════════════════════╤════════════════════════════════════════════╗ ║ Go type │ Conversion ║ ╠═══════════════════════════════════════╪════════════════════════════════════════════╣ ║ nil │ stored as NullValue ║ ║ bool │ stored as BoolValue ║ ║ int, int8, int16, int32, int64 │ stored as NumberValue ║ ║ uint, uint8, uint16, uint32, uint64 │ stored as NumberValue ║ ║ float32, float64 │ stored as NumberValue ║ ║ json.Number │ stored as NumberValue ║ ║ string │ stored as StringValue; must be valid UTF-8 ║ ║ []byte │ stored as StringValue; base64-encoded ║ ║ map[string]any │ stored as StructValue ║ ║ []any │ stored as ListValue ║ ╚═══════════════════════════════════════╧════════════════════════════════════════════╝ When converting an int64 or uint64 to a NumberValue, numeric precision loss is possible since they are stored as a float64.

Package-Level Variables (total 3)

var File_google_protobuf_struct_proto protoreflect.FileDescriptor

var NullValue_name map[int32]string Enum value maps for NullValue.

var NullValue_value map[string]int32 Enum value maps for NullValue.

Package-Level Constants (only one)

const NullValue_NULL_VALUE NullValue = 0 Null value.