Lean  $LEAN_TAG$
IStreamReader.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  *
15 */
16 
17 using System;
18 using System.IO;
19 
21 {
22  /// <summary>
23  /// Defines a transport mechanism for data from its source into various reader methods
24  /// </summary>
25  public interface IStreamReader : IDisposable
26  {
27  /// <summary>
28  /// Gets the transport medium of this stream reader
29  /// </summary>
31 
32  /// <summary>
33  /// Gets whether or not there's more data to be read in the stream
34  /// </summary>
35  bool EndOfStream { get; }
36 
37  /// <summary>
38  /// Gets the next line/batch of content from the stream
39  /// </summary>
40  string ReadLine();
41 
42  /// <summary>
43  /// Direct access to the StreamReader instance
44  /// </summary>
46 
47  /// <summary>
48  /// Gets whether or not this stream reader should be rate limited
49  /// </summary>
50  bool ShouldBeRateLimited { get; }
51  }
52 }