Class EnumValueOptions (3.23.0)

public sealed class EnumValueOptions : IExtendableMessage<EnumValueOptions>, IMessage<EnumValueOptions>, IEquatable<EnumValueOptions>, IDeepCloneable<EnumValueOptions>, IBufferMessage, IMessage

Inheritance

object > EnumValueOptions

Implements

IExtendableMessage EnumValueOptions, IMessage EnumValueOptions, IEquatable EnumValueOptions, IDeepCloneable EnumValueOptions, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Protobuf.Reflection

Assembly

Google.Protobuf.dll

Constructors

EnumValueOptions()

public EnumValueOptions()

EnumValueOptions(EnumValueOptions)

public EnumValueOptions(EnumValueOptions other)

Parameter
Name	Description
`other`	`EnumValueOptions`

Fields

DeprecatedFieldNumber

public const int DeprecatedFieldNumber = 1

Field number for the "deprecated" field.

Field Value
Type	Description
`int`

UninterpretedOptionFieldNumber

public const int UninterpretedOptionFieldNumber = 999

Field number for the "uninterpreted_option" field.

Field Value
Type	Description
`int`

Properties

Deprecated

public bool Deprecated { get; set; }

Is this enum value deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum value, or it will be completely ignored; in the very least, this is a formalization for deprecating enum values.

Property Value
Type	Description
`bool`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

HasDeprecated

public bool HasDeprecated { get; }

Gets whether the "deprecated" field is set

Property Value
Type	Description
`bool`

Parser

public static MessageParser<EnumValueOptions> Parser { get; }

Property Value
Type	Description
`MessageParserEnumValueOptions`

UninterpretedOption

public RepeatedField<UninterpretedOption> UninterpretedOption { get; }

The parser stores options it doesn't recognize here. See above.

Property Value
Type	Description
`RepeatedFieldUninterpretedOption`

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.

ClearDeprecated()

public void ClearDeprecated()

Clears the value of the "deprecated" field

ClearExtension<TValue>(Extension<EnumValueOptions, TValue>)

public void ClearExtension<TValue>(Extension<EnumValueOptions, TValue> extension)

Clears the value of the specified extension

Parameter
Name	Description
`extension`	`ExtensionEnumValueOptions`

Type Parameter
Name	Description
`TValue`

ClearExtension<TValue>(RepeatedExtension<EnumValueOptions, TValue>)

public void ClearExtension<TValue>(RepeatedExtension<EnumValueOptions, TValue> extension)

Clears the value of the specified repeated extension

Parameter
Name	Description
`extension`	`RepeatedExtensionEnumValueOptions`

Type Parameter
Name	Description
`TValue`

Clone()

public EnumValueOptions Clone()

Creates a deep clone of this object.

Returns
Type	Description
`EnumValueOptions`	A deep clone of this object.

Equals(EnumValueOptions)

public bool Equals(EnumValueOptions other)

Parameter
Name	Description
`other`	`EnumValueOptions`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetExtension<TValue>(Extension<EnumValueOptions, TValue>)

public TValue GetExtension<TValue>(Extension<EnumValueOptions, TValue> extension)

Gets the value of the specified extension

Parameter
Name	Description
`extension`	`ExtensionEnumValueOptions`

Returns
Type	Description
`TValue`

Type Parameter
Name	Description
`TValue`

GetExtension<TValue>(RepeatedExtension<EnumValueOptions, TValue>)

public RepeatedField<TValue> GetExtension<TValue>(RepeatedExtension<EnumValueOptions, TValue> extension)

Gets the value of the specified repeated extension or null if the extension isn't registered in this set. For a version of this method that never returns null, use GetOrInitializeExtension<TValue>(RepeatedExtension<T, TValue>)

Parameter
Name	Description
`extension`	`RepeatedExtensionEnumValueOptions`

Returns
Type	Description
`RepeatedField`

Type Parameter
Name	Description
`TValue`

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

GetOrInitializeExtension<TValue>(RepeatedExtension<EnumValueOptions, TValue>)

public RepeatedField<TValue> GetOrInitializeExtension<TValue>(RepeatedExtension<EnumValueOptions, TValue> extension)

Gets the value of the specified repeated extension, registering it if it hasn't already been registered.

Parameter
Name	Description
`extension`	`RepeatedExtensionEnumValueOptions`

Returns
Type	Description
`RepeatedField`

Type Parameter
Name	Description
`TValue`

HasExtension<TValue>(Extension<EnumValueOptions, TValue>)

public bool HasExtension<TValue>(Extension<EnumValueOptions, TValue> extension)

Gets whether the value of the specified extension is set

Parameter
Name	Description
`extension`	`ExtensionEnumValueOptions`

Returns
Type	Description
`bool`

Type Parameter
Name	Description
`TValue`

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(EnumValueOptions)

public void MergeFrom(EnumValueOptions other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`EnumValueOptions`

Remarks

See the user guide for precise merge semantics.

SetExtension<TValue>(Extension<EnumValueOptions, TValue>, TValue)

public void SetExtension<TValue>(Extension<EnumValueOptions, TValue> extension, TValue value)

Sets the value of the specified extension

Parameters
Name	Description
`extension`	`ExtensionEnumValueOptions`
`value`	`TValue`

Type Parameter
Name	Description
`TValue`

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

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

MessageExtensions.IsInitialized(IMessage)

MessageExtensions.MergeDelimitedFrom(IMessage, Stream)

MessageExtensions.MergeFrom(IMessage, ByteString)

MessageExtensions.MergeFrom(IMessage, ReadOnlySequence<byte>)

MessageExtensions.MergeFrom(IMessage, byte[])

MessageExtensions.MergeFrom(IMessage, byte[], int, int)

MessageExtensions.MergeFrom(IMessage, Stream)

MessageExtensions.MergeFrom(IMessage, ReadOnlySpan<byte>)

MessageExtensions.ToByteArray(IMessage)

MessageExtensions.ToByteString(IMessage)

MessageExtensions.WriteDelimitedTo(IMessage, Stream)

MessageExtensions.WriteTo(IMessage, IBufferWriter<byte>)

MessageExtensions.WriteTo(IMessage, Stream)

MessageExtensions.WriteTo(IMessage, Span<byte>)