Class FieldCodec (3.23.0)

Version 3.23.0

• 3.27.1 (latest)
• 3.23.0
• 3.15.8

public static class FieldCodec

Factory methods for FieldCodec<T>.

Inheritance

object > FieldCodec

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace

Google.Protobuf

Assembly

Google.Protobuf.dll

Methods

ForBool(uint)

public static FieldCodec<bool> ForBool(uint tag)

Retrieves a codec suitable for a bool field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecbool	A codec for the given tag.

ForBool(uint, bool)

public static FieldCodec<bool> ForBool(uint tag, bool defaultValue)

Retrieves a codec suitable for a bool field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	bool The default value.

Returns
Type	Description
FieldCodecbool	A codec for the given tag.

ForBytes(uint)

public static FieldCodec<ByteString> ForBytes(uint tag)

Retrieves a codec suitable for a bytes field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecByteString	A codec for the given tag.

ForBytes(uint, ByteString)

public static FieldCodec<ByteString> ForBytes(uint tag, ByteString defaultValue)

Retrieves a codec suitable for a bytes field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	ByteString The default value.

Returns
Type	Description
FieldCodecByteString	A codec for the given tag.

ForClassWrapper<T>(uint)

public static FieldCodec<T> ForClassWrapper<T>(uint tag) where T : class

Creates a codec for a wrapper type of a class - which must be string or ByteString.

Parameter
Name	Description
tag	uint

Returns
Type	Description
FieldCodec

Type Parameter
Name	Description
T

ForDouble(uint)

public static FieldCodec<double> ForDouble(uint tag)

Retrieves a codec suitable for a double field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecdouble	A codec for the given tag.

ForDouble(uint, double)

public static FieldCodec<double> ForDouble(uint tag, double defaultValue)

Retrieves a codec suitable for a double field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	double The default value.

Returns
Type	Description
FieldCodecdouble	A codec for the given tag.

ForEnum<T>(uint, Func<T, int>, Func<int, T>)

public static FieldCodec<T> ForEnum<T>(uint tag, Func<T, int> toInt32, Func<int, T> fromInt32)

Retrieves a codec suitable for an enum field with the given tag.

Parameters
Name	Description
tag	uint The tag.
toInt32	Funcint A conversion function from int to the enum type.
fromInt32	Funcint A conversion function from the enum type to int.

Returns
Type	Description
FieldCodec	A codec for the given tag.

Type Parameter
Name	Description
T

ForEnum<T>(uint, Func<T, int>, Func<int, T>, T)

public static FieldCodec<T> ForEnum<T>(uint tag, Func<T, int> toInt32, Func<int, T> fromInt32, T defaultValue)

Retrieves a codec suitable for an enum field with the given tag.

Parameters
Name	Description
tag	uint The tag.
toInt32	Funcint A conversion function from int to the enum type.
fromInt32	Funcint A conversion function from the enum type to int.
defaultValue	T The default value.

Returns
Type	Description
FieldCodec	A codec for the given tag.

Type Parameter
Name	Description
T

ForFixed32(uint)

public static FieldCodec<uint> ForFixed32(uint tag)

Retrieves a codec suitable for a fixed32 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecuint	A codec for the given tag.

ForFixed32(uint, uint)

public static FieldCodec<uint> ForFixed32(uint tag, uint defaultValue)

Retrieves a codec suitable for a fixed32 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	uint The default value.

Returns
Type	Description
FieldCodecuint	A codec for the given tag.

ForFixed64(uint)

public static FieldCodec<ulong> ForFixed64(uint tag)

Retrieves a codec suitable for a fixed64 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodeculong	A codec for the given tag.

ForFixed64(uint, ulong)

public static FieldCodec<ulong> ForFixed64(uint tag, ulong defaultValue)

Retrieves a codec suitable for a fixed64 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	ulong The default value.

Returns
Type	Description
FieldCodeculong	A codec for the given tag.

ForFloat(uint)

public static FieldCodec<float> ForFloat(uint tag)

Retrieves a codec suitable for a float field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecfloat	A codec for the given tag.

ForFloat(uint, float)

public static FieldCodec<float> ForFloat(uint tag, float defaultValue)

Retrieves a codec suitable for a float field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	float The default value.

Returns
Type	Description
FieldCodecfloat	A codec for the given tag.

ForGroup<T>(uint, uint, MessageParser<T>)

public static FieldCodec<T> ForGroup<T>(uint startTag, uint endTag, MessageParser<T> parser) where T : class, IMessage<T>

Retrieves a codec suitable for a group field with the given tag.

Parameters
Name	Description
startTag	uint The start group tag.
endTag	uint The end group tag.
parser	MessageParser A parser to use for the group message type.

Returns
Type	Description
FieldCodec	A codec for given tag

Type Parameter
Name	Description
T

ForInt32(uint)

public static FieldCodec<int> ForInt32(uint tag)

Retrieves a codec suitable for an int32 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecint	A codec for the given tag.

ForInt32(uint, int)

public static FieldCodec<int> ForInt32(uint tag, int defaultValue)

Retrieves a codec suitable for an int32 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	int The default value.

Returns
Type	Description
FieldCodecint	A codec for the given tag.

ForInt64(uint)

public static FieldCodec<long> ForInt64(uint tag)

Retrieves a codec suitable for an int64 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodeclong	A codec for the given tag.

ForInt64(uint, long)

public static FieldCodec<long> ForInt64(uint tag, long defaultValue)

Retrieves a codec suitable for an int64 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	long The default value.

Returns
Type	Description
FieldCodeclong	A codec for the given tag.

ForMessage<T>(uint, MessageParser<T>)

public static FieldCodec<T> ForMessage<T>(uint tag, MessageParser<T> parser) where T : class, IMessage<T>

Retrieves a codec suitable for a message field with the given tag.

Parameters
Name	Description
tag	uint The tag.
parser	MessageParser A parser to use for the message type.

Returns
Type	Description
FieldCodec	A codec for the given tag.

Type Parameter
Name	Description
T

ForSFixed32(uint)

public static FieldCodec<int> ForSFixed32(uint tag)

Retrieves a codec suitable for an sfixed32 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecint	A codec for the given tag.

ForSFixed32(uint, int)

public static FieldCodec<int> ForSFixed32(uint tag, int defaultValue)

Retrieves a codec suitable for an sfixed32 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	int The default value.

Returns
Type	Description
FieldCodecint	A codec for the given tag.

ForSFixed64(uint)

public static FieldCodec<long> ForSFixed64(uint tag)

Retrieves a codec suitable for an sfixed64 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodeclong	A codec for the given tag.

ForSFixed64(uint, long)

public static FieldCodec<long> ForSFixed64(uint tag, long defaultValue)

Retrieves a codec suitable for an sfixed64 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	long The default value.

Returns
Type	Description
FieldCodeclong	A codec for the given tag.

ForSInt32(uint)

public static FieldCodec<int> ForSInt32(uint tag)

Retrieves a codec suitable for an sint32 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecint	A codec for the given tag.

ForSInt32(uint, int)

public static FieldCodec<int> ForSInt32(uint tag, int defaultValue)

Retrieves a codec suitable for an sint32 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	int The default value.

Returns
Type	Description
FieldCodecint	A codec for the given tag.

ForSInt64(uint)

public static FieldCodec<long> ForSInt64(uint tag)

Retrieves a codec suitable for an sint64 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodeclong	A codec for the given tag.

ForSInt64(uint, long)

public static FieldCodec<long> ForSInt64(uint tag, long defaultValue)

Retrieves a codec suitable for an sint64 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	long The default value.

Returns
Type	Description
FieldCodeclong	A codec for the given tag.

ForString(uint)

public static FieldCodec<string> ForString(uint tag)

Retrieves a codec suitable for a string field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecstring	A codec for the given tag.

ForString(uint, string)

public static FieldCodec<string> ForString(uint tag, string defaultValue)

Retrieves a codec suitable for a string field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	string The default value.

Returns
Type	Description
FieldCodecstring	A codec for the given tag.

ForStructWrapper<T>(uint)

public static FieldCodec<T?> ForStructWrapper<T>(uint tag) where T : struct

Creates a codec for a wrapper type of a struct - which must be Int32, Int64, UInt32, UInt64, Bool, Single or Double.

Parameter
Name	Description
tag	uint

Returns
Type	Description
FieldCodec

Type Parameter
Name	Description
T

ForUInt32(uint)

public static FieldCodec<uint> ForUInt32(uint tag)

Retrieves a codec suitable for a uint32 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodecuint	A codec for the given tag.

ForUInt32(uint, uint)

public static FieldCodec<uint> ForUInt32(uint tag, uint defaultValue)

Retrieves a codec suitable for a uint32 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	uint The default value.

Returns
Type	Description
FieldCodecuint	A codec for the given tag.

ForUInt64(uint)

public static FieldCodec<ulong> ForUInt64(uint tag)

Retrieves a codec suitable for a uint64 field with the given tag.

Parameter
Name	Description
tag	uint The tag.

Returns
Type	Description
FieldCodeculong	A codec for the given tag.

ForUInt64(uint, ulong)

public static FieldCodec<ulong> ForUInt64(uint tag, ulong defaultValue)

Retrieves a codec suitable for a uint64 field with the given tag.

Parameters
Name	Description
tag	uint The tag.
defaultValue	ulong The default value.

Returns
Type	Description
FieldCodeculong	A codec for the given tag.