Class Struct (3.23.0) 

public sealed class Struct : IMessage<Struct>, IEquatable<Struct>, IDeepCloneable<Struct>, IBufferMessage, IMessage

Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.

The JSON representation for Struct is JSON object.

Inheritance

object > Struct

Namespace

Google.Protobuf.WellKnownTypes

Assembly

Google.Protobuf.dll

Constructors

Struct()

public Struct()

Struct(Struct)

public Struct(Struct other)
Parameter
Name Description
other Struct

Fields

FieldsFieldNumber

public const int FieldsFieldNumber = 1

Field number for the "fields" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Fields

public MapField<string, Value> Fields { get; }

Unordered map of dynamically typed values.

Property Value
Type Description
MapFieldstringValue

Parser

public static MessageParser<Struct> Parser { get; }
Property Value
Type Description
MessageParserStruct

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public Struct Clone()

Creates a deep clone of this object.

Returns
Type Description
Struct

A deep clone of this object.

Equals(Struct)

public bool Equals(Struct other)
Parameter
Name Description
other Struct
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

MergeFrom(Struct)

public void MergeFrom(Struct other)

Merges the given message into this one.

Parameter
Name Description
other Struct
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.

Extension Methods