TextReaderAdapter.cs 17.2 KB
Newer Older
Fabien Bondi's avatar
Fabien Bondi committed
1 2
#region Copyright (c) 2017 Leoxia Ltd

Fabien Bondi's avatar
Fabien Bondi committed
3 4 5 6
// --------------------------------------------------------------------------------------------------------------------
// <copyright file="TextReaderAdapter.cs" company="Leoxia Ltd">
//    Copyright (c) 2017 Leoxia Ltd
// </copyright>
Fabien Bondi's avatar
Fabien Bondi committed
7
// 
Fabien Bondi's avatar
Fabien Bondi committed
8 9 10 11
// .NET Software Development
// https://www.leoxia.com
// Build. Tomorrow. Together
// 
Fabien Bondi's avatar
Fabien Bondi committed
12
// MIT License
Fabien Bondi's avatar
Fabien Bondi committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
Fabien Bondi's avatar
Fabien Bondi committed
31
//  --------------------------------------------------------------------------------------------------------------------
Fabien Bondi's avatar
Fabien Bondi committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133

#endregion

#region Usings

using System.IO;
using System.Threading.Tasks;
using Leoxia.Abstractions.IO;

#endregion

namespace Leoxia.Implementations.IO
{
    /// <summary>
    ///     Adapter for TextReader to ITextReader
    /// </summary>
    /// <seealso cref="Leoxia.Abstractions.IO.ITextReader" />
    public class TextReaderAdapter : ITextReader
    {
        private readonly TextReader _textReaderImplementation;

        /// <summary>
        ///     Initializes a new instance of the <see cref="TextReaderAdapter" /> class.
        /// </summary>
        /// <param name="textReaderImplementation">The text reader implementation.</param>
        public TextReaderAdapter(TextReader textReaderImplementation)
        {
            _textReaderImplementation = textReaderImplementation;
        }

        /// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
        public void Dispose()
        {
            _textReaderImplementation.Dispose();
        }

        /// <summary>
        ///     Reads the next character without changing the state of the reader or the character source. Returns the next
        ///     available character without actually reading it from the reader.
        /// </summary>
        /// <returns>
        ///     An integer representing the next character to be read, or -1 if no more characters are available or the reader
        ///     does not support seeking.
        /// </returns>
        /// <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.TextReader" /> is closed. </exception>
        /// <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
        /// <filterpriority>1</filterpriority>
        public int Peek()
        {
            return _textReaderImplementation.Peek();
        }

        /// <summary>Reads the next character from the text reader and advances the character position by one character.</summary>
        /// <returns>
        ///     The next character from the text reader, or -1 if no more characters are available. The default implementation
        ///     returns -1.
        /// </returns>
        /// <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.TextReader" /> is closed. </exception>
        /// <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
        /// <filterpriority>1</filterpriority>
        public int Read()
        {
            return _textReaderImplementation.Read();
        }

        /// <summary>
        ///     Reads a specified maximum number of characters from the current reader and writes the data to a buffer,
        ///     beginning at the specified index.
        /// </summary>
        /// <returns>
        ///     The number of characters that have been read. The number will be less than or equal to
        ///     <paramref name="count" />, depending on whether the data is available within the reader. This method returns 0
        ///     (zero) if it is called when no more characters are left to read.
        /// </returns>
        /// <param name="buffer">
        ///     When this method returns, contains the specified character array with the values between
        ///     <paramref name="index" /> and (<paramref name="index" /> + <paramref name="count" /> - 1) replaced by the
        ///     characters read from the current source.
        /// </param>
        /// <param name="index">The position in <paramref name="buffer" /> at which to begin writing. </param>
        /// <param name="count">
        ///     The maximum number of characters to read. If the end of the reader is reached before the specified
        ///     number of characters is read into the buffer, the method returns.
        /// </param>
        /// <exception cref="T:System.ArgumentNullException">
        ///     <paramref name="buffer" /> is null.
        /// </exception>
        /// <exception cref="T:System.ArgumentException">
        ///     The buffer length minus <paramref name="index" /> is less than
        ///     <paramref name="count" />.
        /// </exception>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     <paramref name="index" /> or <paramref name="count" /> is negative.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.TextReader" /> is closed. </exception>
        /// <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
        /// <filterpriority>1</filterpriority>
        public int Read(char[] buffer, int index, int count)
        {
            return _textReaderImplementation.Read(buffer, index, count);
        }

134 135
        #if (!NET40)

Fabien Bondi's avatar
Fabien Bondi committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
        /// <summary>
        ///     Reads a specified maximum number of characters from the current text reader asynchronously and writes the data
        ///     to a buffer, beginning at the specified index.
        /// </summary>
        /// <returns>
        ///     A task that represents the asynchronous read operation. The value of the string parameter
        ///     contains the total number of bytes read into the buffer. The result value can be less than the number of bytes
        ///     requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if
        ///     the end of the text has been reached.
        /// </returns>
        /// <param name="buffer">
        ///     When this method returns, contains the specified character array with the values between
        ///     <paramref name="index" /> and (<paramref name="index" /> + <paramref name="count" /> - 1) replaced by the
        ///     characters read from the current source.
        /// </param>
        /// <param name="index">The position in <paramref name="buffer" /> at which to begin writing.</param>
        /// <param name="count">
        ///     The maximum number of characters to read. If the end of the text is reached before the specified
        ///     number of characters is read into the buffer, the current method returns.
        /// </param>
        /// <exception cref="T:System.ArgumentNullException">
        ///     <paramref name="buffer" /> is null.
        /// </exception>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     <paramref name="index" /> or <paramref name="count" /> is negative.
        /// </exception>
        /// <exception cref="T:System.ArgumentException">
        ///     The sum of <paramref name="index" /> and <paramref name="count" /> is
        ///     larger than the buffer length.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The text reader has been disposed.</exception>
        /// <exception cref="T:System.InvalidOperationException">The reader is currently in use by a previous read operation. </exception>
        public Task<int> ReadAsync(char[] buffer, int index, int count)
        {
            return _textReaderImplementation.ReadAsync(buffer, index, count);
        }

173 174
        #endif

Fabien Bondi's avatar
Fabien Bondi committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
        /// <summary>
        ///     Reads a specified maximum number of characters from the current text reader and writes the data to a buffer,
        ///     beginning at the specified index.
        /// </summary>
        /// <returns>
        ///     The number of characters that have been read. The number will be less than or equal to
        ///     <paramref name="count" />, depending on whether all input characters have been read.
        /// </returns>
        /// <param name="buffer">
        ///     When this method returns, this parameter contains the specified character array with the values
        ///     between <paramref name="index" /> and (<paramref name="index" /> + <paramref name="count" /> -1) replaced by the
        ///     characters read from the current source.
        /// </param>
        /// <param name="index">The position in <paramref name="buffer" /> at which to begin writing.</param>
        /// <param name="count">The maximum number of characters to read. </param>
        /// <exception cref="T:System.ArgumentNullException">
        ///     <paramref name="buffer" /> is null.
        /// </exception>
        /// <exception cref="T:System.ArgumentException">
        ///     The buffer length minus <paramref name="index" /> is less than
        ///     <paramref name="count" />.
        /// </exception>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     <paramref name="index" /> or <paramref name="count" /> is negative.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.TextReader" /> is closed. </exception>
        /// <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
        /// <filterpriority>2</filterpriority>
        public int ReadBlock(char[] buffer, int index, int count)
        {
            return _textReaderImplementation.ReadBlock(buffer, index, count);
        }

208 209
#if (!NET40)
                
Fabien Bondi's avatar
Fabien Bondi committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        /// <summary>
        ///     Reads a specified maximum number of characters from the current text reader asynchronously and writes the data
        ///     to a buffer, beginning at the specified index.
        /// </summary>
        /// <returns>
        ///     A task that represents the asynchronous read operation. The value of the string parameter
        ///     contains the total number of bytes read into the buffer. The result value can be less than the number of bytes
        ///     requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if
        ///     the end of the text has been reached.
        /// </returns>
        /// <param name="buffer">
        ///     When this method returns, contains the specified character array with the values between
        ///     <paramref name="index" /> and (<paramref name="index" /> + <paramref name="count" /> - 1) replaced by the
        ///     characters read from the current source.
        /// </param>
        /// <param name="index">The position in <paramref name="buffer" /> at which to begin writing.</param>
        /// <param name="count">
        ///     The maximum number of characters to read. If the end of the text is reached before the specified
        ///     number of characters is read into the buffer, the current method returns.
        /// </param>
        /// <exception cref="T:System.ArgumentNullException">
        ///     <paramref name="buffer" /> is null.
        /// </exception>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     <paramref name="index" /> or <paramref name="count" /> is negative.
        /// </exception>
        /// <exception cref="T:System.ArgumentException">
        ///     The sum of <paramref name="index" /> and <paramref name="count" /> is
        ///     larger than the buffer length.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The text reader has been disposed.</exception>
        /// <exception cref="T:System.InvalidOperationException">The reader is currently in use by a previous read operation. </exception>
        public Task<int> ReadBlockAsync(char[] buffer, int index, int count)
        {
            return _textReaderImplementation.ReadBlockAsync(buffer, index, count);
        }

247 248
#endif

Fabien Bondi's avatar
Fabien Bondi committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
        /// <summary>Reads a line of characters from the text reader and returns the data as a string.</summary>
        /// <returns>The next line from the reader, or null if all characters have been read.</returns>
        /// <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
        /// <exception cref="T:System.OutOfMemoryException">
        ///     There is insufficient memory to allocate a buffer for the returned
        ///     string.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.TextReader" /> is closed. </exception>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     The number of characters in the next line is larger than
        ///     <see cref="F:System.Int32.MaxValue" />
        /// </exception>
        /// <filterpriority>1</filterpriority>
        public string ReadLine()
        {
            return _textReaderImplementation.ReadLine();
        }

267 268
#if (!NET40)

Fabien Bondi's avatar
Fabien Bondi committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
        /// <summary>Reads a line of characters asynchronously and returns the data as a string. </summary>
        /// <returns>
        ///     A task that represents the asynchronous read operation. The value of the string parameter
        ///     contains the next line from the text reader, or is null if all of the characters have been read.
        /// </returns>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     The number of characters in the next line is larger than
        ///     <see cref="F:System.Int32.MaxValue" />.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The text reader has been disposed.</exception>
        /// <exception cref="T:System.InvalidOperationException">The reader is currently in use by a previous read operation. </exception>
        public Task<string> ReadLineAsync()
        {
            return _textReaderImplementation.ReadLineAsync();
        }

285 286
#endif

Fabien Bondi's avatar
Fabien Bondi committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
        /// <summary>Reads all characters from the current position to the end of the text reader and returns them as one string.</summary>
        /// <returns>A string that contains all characters from the current position to the end of the text reader.</returns>
        /// <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
        /// <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.IO.TextReader" /> is closed. </exception>
        /// <exception cref="T:System.OutOfMemoryException">
        ///     There is insufficient memory to allocate a buffer for the returned
        ///     string.
        /// </exception>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     The number of characters in the next line is larger than
        ///     <see cref="F:System.Int32.MaxValue" />
        /// </exception>
        /// <filterpriority>1</filterpriority>
        public string ReadToEnd()
        {
            return _textReaderImplementation.ReadToEnd();
        }

305 306
#if (!NET40)

Fabien Bondi's avatar
Fabien Bondi committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
        /// <summary>
        ///     Reads all characters from the current position to the end of the text reader asynchronously and returns them
        ///     as one string.
        /// </summary>
        /// <returns>
        ///     A task that represents the asynchronous read operation. The value of the string
        ///     contains a string with the characters from the current position to the end of the text reader.
        /// </returns>
        /// <exception cref="T:System.ArgumentOutOfRangeException">
        ///     The number of characters is larger than
        ///     <see cref="F:System.Int32.MaxValue" />.
        /// </exception>
        /// <exception cref="T:System.ObjectDisposedException">The text reader has been disposed.</exception>
        /// <exception cref="T:System.InvalidOperationException">The reader is currently in use by a previous read operation. </exception>
        public Task<string> ReadToEndAsync()
        {
            return _textReaderImplementation.ReadToEndAsync();
        }
325 326 327

#endif

Fabien Bondi's avatar
Fabien Bondi committed
328
    }
Fabien Bondi's avatar
Fabien Bondi committed
329
}