MessageExtensions.cs 7.16 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
#region Copyright notice and license
// Protocol Buffers - Google's data interchange format
// Copyright 2015 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#endregion

using System.IO;
34 35 36

namespace Google.Protobuf
{
Jon Skeet's avatar
Jon Skeet committed
37 38 39 40
    /// <summary>
    /// Extension methods on <see cref="IMessage"/> and <see cref="IMessage{T}"/>.
    /// </summary>
    public static class MessageExtensions
41
    {
42 43 44 45 46
        /// <summary>
        /// Merges data from the given byte array into an existing message.
        /// </summary>
        /// <param name="message">The message to merge the data into.</param>
        /// <param name="data">The data to merge, which must be protobuf-encoded binary data.</param>
47 48
        public static void MergeFrom(this IMessage message, byte[] data)
        {
49 50
            Preconditions.CheckNotNull(message, "message");
            Preconditions.CheckNotNull(data, "data");
51
            CodedInputStream input = new CodedInputStream(data);
52
            message.MergeFrom(input);
Jon Skeet's avatar
Jon Skeet committed
53
            input.CheckReadEndOfStreamTag();
54 55
        }

56 57 58 59 60
        /// <summary>
        /// Merges data from the given byte string into an existing message.
        /// </summary>
        /// <param name="message">The message to merge the data into.</param>
        /// <param name="data">The data to merge, which must be protobuf-encoded binary data.</param>
61 62
        public static void MergeFrom(this IMessage message, ByteString data)
        {
63 64
            Preconditions.CheckNotNull(message, "message");
            Preconditions.CheckNotNull(data, "data");
65 66
            CodedInputStream input = data.CreateCodedInput();
            message.MergeFrom(input);
Jon Skeet's avatar
Jon Skeet committed
67
            input.CheckReadEndOfStreamTag();
68 69
        }

70 71 72 73 74
        /// <summary>
        /// Merges data from the given stream into an existing message.
        /// </summary>
        /// <param name="message">The message to merge the data into.</param>
        /// <param name="input">Stream containing the data to merge, which must be protobuf-encoded binary data.</param>
75 76
        public static void MergeFrom(this IMessage message, Stream input)
        {
77 78
            Preconditions.CheckNotNull(message, "message");
            Preconditions.CheckNotNull(input, "input");
79
            CodedInputStream codedInput = new CodedInputStream(input);
80
            message.MergeFrom(codedInput);
Jon Skeet's avatar
Jon Skeet committed
81
            codedInput.CheckReadEndOfStreamTag();
82 83
        }

84 85 86 87 88 89 90 91 92
        /// <summary>
        /// Merges length-delimited data from the given stream into an existing message.
        /// </summary>
        /// <remarks>
        /// The stream is expected to contain a length and then the data. Only the amount of data
        /// specified by the length will be consumed.
        /// </remarks>
        /// <param name="message">The message to merge the data into.</param>
        /// <param name="input">Stream containing the data to merge, which must be protobuf-encoded binary data.</param>
93 94
        public static void MergeDelimitedFrom(this IMessage message, Stream input)
        {
95 96
            Preconditions.CheckNotNull(message, "message");
            Preconditions.CheckNotNull(input, "input");
97
            int size = (int) CodedInputStream.ReadRawVarint32(input);
98 99 100 101
            Stream limitedStream = new LimitedInputStream(input, size);
            message.MergeFrom(limitedStream);
        }

102 103 104 105 106
        /// <summary>
        /// Converts the given message into a byte array in protobuf encoding.
        /// </summary>
        /// <param name="message">The message to convert.</param>
        /// <returns>The message data as a byte array.</returns>
107 108
        public static byte[] ToByteArray(this IMessage message)
        {
109
            Preconditions.CheckNotNull(message, "message");
110
            byte[] result = new byte[message.CalculateSize()];
111
            CodedOutputStream output = new CodedOutputStream(result);
112 113 114 115 116
            message.WriteTo(output);
            output.CheckNoSpaceLeft();
            return result;
        }

117 118 119 120 121
        /// <summary>
        /// Writes the given message data to the given stream in protobuf encoding.
        /// </summary>
        /// <param name="message">The message to write to the stream.</param>
        /// <param name="output">The stream to write to.</param>
122 123
        public static void WriteTo(this IMessage message, Stream output)
        {
124 125
            Preconditions.CheckNotNull(message, "message");
            Preconditions.CheckNotNull(output, "output");
126
            CodedOutputStream codedOutput = new CodedOutputStream(output);
127 128 129 130
            message.WriteTo(codedOutput);
            codedOutput.Flush();
        }

131 132 133 134 135
        /// <summary>
        /// Writes the length and then data of the given message to a stream.
        /// </summary>
        /// <param name="message">The message to write.</param>
        /// <param name="output">The output stream to write to.</param>
136 137
        public static void WriteDelimitedTo(this IMessage message, Stream output)
        {
138 139
            Preconditions.CheckNotNull(message, "message");
            Preconditions.CheckNotNull(output, "output");
140
            CodedOutputStream codedOutput = new CodedOutputStream(output);
141 142 143 144 145
            codedOutput.WriteRawVarint32((uint)message.CalculateSize());
            message.WriteTo(codedOutput);
            codedOutput.Flush();
        }

146 147 148 149 150
        /// <summary>
        /// Converts the given message into a byte string in protobuf encoding.
        /// </summary>
        /// <param name="message">The message to convert.</param>
        /// <returns>The message data as a byte string.</returns>
151 152
        public static ByteString ToByteString(this IMessage message)
        {
153
            Preconditions.CheckNotNull(message, "message");
154 155 156 157
            return ByteString.AttachBytes(message.ToByteArray());
        }        
    }
}