diff --git a/src/ProtocolBuffers/CodedOutputStream.ComputeSize.cs b/src/ProtocolBuffers/CodedOutputStream.ComputeSize.cs index ef197d8f9b..50bf28d23e 100644 --- a/src/ProtocolBuffers/CodedOutputStream.ComputeSize.cs +++ b/src/ProtocolBuffers/CodedOutputStream.ComputeSize.cs @@ -41,19 +41,9 @@ using Google.ProtocolBuffers.Descriptors; namespace Google.ProtocolBuffers { - /// - /// Encodes and writes protocol message fields. - /// - /// - /// This class contains two kinds of methods: methods that write specific - /// protocol message constructs and field types (e.g. WriteTag and - /// WriteInt32) and methods that write low-level values (e.g. - /// WriteRawVarint32 and WriteRawBytes). If you are writing encoded protocol - /// messages, you should use the former methods, but if you are writing some - /// other format of your own design, use the latter. The names of the former - /// methods are taken from the protocol buffer type names, not .NET types. - /// (Hence WriteFloat instead of WriteSingle, and WriteBool instead of WriteBoolean.) - /// + // This part of CodedOutputStream provides all the static entry points that are used + // by generated code and internally to compute the size of messages prior to being + // written to an instance of CodedOutputStream. public sealed partial class CodedOutputStream { private const int LittleEndian64Size = 8; diff --git a/src/ProtocolBuffers/ICodedInputStream.cs b/src/ProtocolBuffers/ICodedInputStream.cs index 683968ee5e..f2360021e0 100644 --- a/src/ProtocolBuffers/ICodedInputStream.cs +++ b/src/ProtocolBuffers/ICodedInputStream.cs @@ -234,48 +234,93 @@ namespace Google.ProtocolBuffers [CLSCompliant(false)] bool SkipField(); + /// + /// Reads one or more repeated string field values from the stream. + /// [CLSCompliant(false)] void ReadStringArray(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated ByteString field values from the stream. + /// [CLSCompliant(false)] void ReadBytesArray(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated boolean field values from the stream. + /// [CLSCompliant(false)] void ReadBoolArray(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated Int32 field values from the stream. + /// [CLSCompliant(false)] void ReadInt32Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated SInt32 field values from the stream. + /// [CLSCompliant(false)] void ReadSInt32Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated UInt32 field values from the stream. + /// [CLSCompliant(false)] void ReadUInt32Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated Fixed32 field values from the stream. + /// [CLSCompliant(false)] void ReadFixed32Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated SFixed32 field values from the stream. + /// [CLSCompliant(false)] void ReadSFixed32Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated Int64 field values from the stream. + /// [CLSCompliant(false)] void ReadInt64Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated SInt64 field values from the stream. + /// [CLSCompliant(false)] void ReadSInt64Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated UInt64 field values from the stream. + /// [CLSCompliant(false)] void ReadUInt64Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated Fixed64 field values from the stream. + /// [CLSCompliant(false)] void ReadFixed64Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated SFixed64 field values from the stream. + /// [CLSCompliant(false)] void ReadSFixed64Array(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated Double field values from the stream. + /// [CLSCompliant(false)] void ReadDoubleArray(uint fieldTag, string fieldName, ICollection list); + /// + /// Reads one or more repeated Float field values from the stream. + /// [CLSCompliant(false)] void ReadFloatArray(uint fieldTag, string fieldName, ICollection list); } diff --git a/src/ProtocolBuffers/ICodedOutputStream.cs b/src/ProtocolBuffers/ICodedOutputStream.cs index df8ca10724..861d3fece6 100644 --- a/src/ProtocolBuffers/ICodedOutputStream.cs +++ b/src/ProtocolBuffers/ICodedOutputStream.cs @@ -44,21 +44,43 @@ using Google.ProtocolBuffers.Descriptors; namespace Google.ProtocolBuffers { + /// + /// Provides an interface that is used write a message. Most often proto buffers are written + /// in their binary form by creating a instance via the CodedOutputStream.CreateInstance + /// static factory. + /// public interface ICodedOutputStream { + /// + /// Indicates that all temporary buffers be written to the final output. + /// void Flush(); - + /// + /// Writes an unknown message as a group + /// [Obsolete] void WriteUnknownGroup(int fieldNumber, IMessageLite value); - + /// + /// Writes an unknown field value of bytes + /// void WriteUnknownBytes(int fieldNumber, ByteString value); - + /// + /// Writes an unknown field of a primitive type + /// [CLSCompliant(false)] void WriteUnknownField(int fieldNumber, WireFormat.WireType wireType, ulong value); - + /// + /// Writes an extension as a message-set group + /// void WriteMessageSetExtension(int fieldNumber, string fieldName, IMessageLite value); + /// + /// Writes an unknown extension as a message-set group + /// void WriteMessageSetExtension(int fieldNumber, string fieldName, ByteString value); + /// + /// Writes a field value, including tag, to the stream. + /// void WriteField(FieldType fieldType, int fieldNumber, string fieldName, object value); /// @@ -155,76 +177,178 @@ namespace Google.ProtocolBuffers /// void WriteSInt64(int fieldNumber, string fieldName, long value); + /// + /// Writes a repeated field value, including tag(s), to the stream. + /// void WriteArray(FieldType fieldType, int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated group value, including tag(s), to the stream. + /// void WriteGroupArray(int fieldNumber, string fieldName, IEnumerable list) where T : IMessageLite; + /// + /// Writes a repeated message value, including tag(s), to the stream. + /// void WriteMessageArray(int fieldNumber, string fieldName, IEnumerable list) where T : IMessageLite; + /// + /// Writes a repeated string value, including tag(s), to the stream. + /// void WriteStringArray(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated ByteString value, including tag(s), to the stream. + /// void WriteBytesArray(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated boolean value, including tag(s), to the stream. + /// void WriteBoolArray(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated Int32 value, including tag(s), to the stream. + /// void WriteInt32Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated SInt32 value, including tag(s), to the stream. + /// void WriteSInt32Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated UInt32 value, including tag(s), to the stream. + /// void WriteUInt32Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated Fixed32 value, including tag(s), to the stream. + /// void WriteFixed32Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated SFixed32 value, including tag(s), to the stream. + /// void WriteSFixed32Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated Int64 value, including tag(s), to the stream. + /// void WriteInt64Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated SInt64 value, including tag(s), to the stream. + /// void WriteSInt64Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated UInt64 value, including tag(s), to the stream. + /// void WriteUInt64Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated Fixed64 value, including tag(s), to the stream. + /// void WriteFixed64Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated SFixed64 value, including tag(s), to the stream. + /// void WriteSFixed64Array(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated Double value, including tag(s), to the stream. + /// void WriteDoubleArray(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated Float value, including tag(s), to the stream. + /// void WriteFloatArray(int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a repeated enumeration value of type T, including tag(s), to the stream. + /// [CLSCompliant(false)] void WriteEnumArray(int fieldNumber, string fieldName, IEnumerable list) where T : struct, IComparable, IFormattable, IConvertible; + /// + /// Writes a packed repeated primitive, including tag and length, to the stream. + /// void WritePackedArray(FieldType fieldType, int fieldNumber, string fieldName, IEnumerable list); + /// + /// Writes a packed repeated boolean, including tag and length, to the stream. + /// void WritePackedBoolArray(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated Int32, including tag and length, to the stream. + /// void WritePackedInt32Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated SInt32, including tag and length, to the stream. + /// void WritePackedSInt32Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated UInt32, including tag and length, to the stream. + /// void WritePackedUInt32Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated Fixed32, including tag and length, to the stream. + /// void WritePackedFixed32Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated SFixed32, including tag and length, to the stream. + /// void WritePackedSFixed32Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated Int64, including tag and length, to the stream. + /// void WritePackedInt64Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated SInt64, including tag and length, to the stream. + /// void WritePackedSInt64Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated UInt64, including tag and length, to the stream. + /// void WritePackedUInt64Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated Fixed64, including tag and length, to the stream. + /// void WritePackedFixed64Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated SFixed64, including tag and length, to the stream. + /// void WritePackedSFixed64Array(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated Double, including tag and length, to the stream. + /// void WritePackedDoubleArray(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated Float, including tag and length, to the stream. + /// void WritePackedFloatArray(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list); + /// + /// Writes a packed repeated enumeration of type T, including tag and length, to the stream. + /// [CLSCompliant(false)] void WritePackedEnumArray(int fieldNumber, string fieldName, int calculatedSize, IEnumerable list) where T : struct, IComparable, IFormattable, IConvertible;