Space Engineers
Public Member Functions | Properties | List of all members
ProtoBuf.ProtoPartialMemberAttribute Class Reference

Declares a member to be used in protocol-buffer serialization, using the given Tag and MemberName. This allows ProtoMemberAttribute usage even for partial classes where the individual members are not under direct control. A DataFormat may be used to optimise the serialization format (for instance, using zigzag encoding for negative numbers, or fixed-length encoding for large values. More...

Inheritance diagram for ProtoBuf.ProtoPartialMemberAttribute:
ProtoBuf.ProtoMemberAttribute

Public Member Functions

 ProtoPartialMemberAttribute (int tag, string memberName)
 Creates a new ProtoMemberAttribute instance. More...
 
- Public Member Functions inherited from ProtoBuf.ProtoMemberAttribute
int CompareTo (object other)
 Compare with another ProtoMemberAttribute for sorting purposes More...
 
int CompareTo (ProtoMemberAttribute other)
 Compare with another ProtoMemberAttribute for sorting purposes More...
 
 ProtoMemberAttribute ([CallerLineNumber]int tag=0)
 Creates a new ProtoMemberAttribute instance. More...
 

Properties

string MemberName [get]
 The name of the member to be serialized. More...
 
- Properties inherited from ProtoBuf.ProtoMemberAttribute
string Name [get, set]
 Gets or sets the original name defined in the .proto; not used during serialization. More...
 
DataFormat DataFormat [get, set]
 Gets or sets the data-format to be used when encoding this value. More...
 
int Tag [get]
 Gets the unique tag used to identify this member within the type. More...
 
bool IsRequired [get, set]
 Gets or sets a value indicating whether this member is mandatory. More...
 
bool IsPacked [get, set]
 Gets a value indicating whether this member is packed. This option only applies to list/array data of primitive types (int, double, etc). More...
 
bool OverwriteList [get, set]
 Indicates whether this field should repace existing values (the default is false, meaning append). This option only applies to list/array data. More...
 
bool AsReference [get, set]
 Enables full object-tracking/full-graph support. More...
 
bool DynamicType [get, set]
 Embeds the type information into the stream, allowing usage with types not known in advance. More...
 
MemberSerializationOptions Options [get, set]
 Gets or sets a value indicating whether this member is packed (lists/arrays). More...
 

Detailed Description

Declares a member to be used in protocol-buffer serialization, using the given Tag and MemberName. This allows ProtoMemberAttribute usage even for partial classes where the individual members are not under direct control. A DataFormat may be used to optimise the serialization format (for instance, using zigzag encoding for negative numbers, or fixed-length encoding for large values.

Definition at line 241 of file ProtoMemberAttribute.cs.

Constructor & Destructor Documentation

ProtoBuf.ProtoPartialMemberAttribute.ProtoPartialMemberAttribute ( int  tag,
string  memberName 
)
inline

Creates a new ProtoMemberAttribute instance.

Parameters
tagSpecifies the unique tag used to identify this member within the type.
memberNameSpecifies the member to be serialized.

Definition at line 248 of file ProtoMemberAttribute.cs.

Property Documentation

string ProtoBuf.ProtoPartialMemberAttribute.MemberName
get

The name of the member to be serialized.

Definition at line 262 of file ProtoMemberAttribute.cs.


The documentation for this class was generated from the following file: