Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader Class Reference

Represents a stream reader capable of reading lines from disk More...

Inheritance diagram for QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader:
[legend]

Public Member Functions

 LocalFileSubscriptionStreamReader (IDataCacheProvider dataCacheProvider, string source, string entryName=null)
 Initializes a new instance of the LocalFileSubscriptionStreamReader class. More...
 
 LocalFileSubscriptionStreamReader (IDataCacheProvider dataCacheProvider, string source, long startingPosition)
 Initializes a new instance of the LocalFileSubscriptionStreamReader class. More...
 
 LocalFileSubscriptionStreamReader (ZipFile zipFile, string entryName=null)
 Initializes a new instance of the LocalFileSubscriptionStreamReader class. More...
 
string ReadLine ()
 Gets the next line/batch of content from the stream More...
 
void Dispose ()
 Disposes of the stream More...
 

Public Attributes

bool ShouldBeRateLimited => false
 Gets whether or not this stream reader should be rate limited More...
 

Properties

StreamReader StreamReader [get]
 Direct access to the StreamReader instance More...
 
IEnumerable< string >? EntryFileNames [get]
 Returns the list of zip entries if local file stream reader is reading zip archive More...
 
SubscriptionTransportMedium TransportMedium [get]
 Gets SubscriptionTransportMedium.LocalFile More...
 
bool EndOfStream [get]
 Gets whether or not there's more data to be read in the stream More...
 
- Properties inherited from QuantConnect.Interfaces.IStreamReader
SubscriptionTransportMedium TransportMedium [get]
 Gets the transport medium of this stream reader More...
 
bool EndOfStream [get]
 Gets whether or not there's more data to be read in the stream More...
 
StreamReader StreamReader [get]
 Direct access to the StreamReader instance More...
 
bool ShouldBeRateLimited [get]
 Gets whether or not this stream reader should be rate limited More...
 

Detailed Description

Represents a stream reader capable of reading lines from disk

Definition at line 29 of file LocalFileSubscriptionStreamReader.cs.

Constructor & Destructor Documentation

◆ LocalFileSubscriptionStreamReader() [1/3]

QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.LocalFileSubscriptionStreamReader ( IDataCacheProvider  dataCacheProvider,
string  source,
string  entryName = null 
)

Initializes a new instance of the LocalFileSubscriptionStreamReader class.

Parameters
dataCacheProviderThe IDataCacheProvider used to retrieve a stream of data
sourceThe local file to be read
entryNameSpecifies the zip entry to be opened. Leave null if not applicable, or to open the first zip entry found regardless of name

Definition at line 50 of file LocalFileSubscriptionStreamReader.cs.

Here is the call graph for this function:

◆ LocalFileSubscriptionStreamReader() [2/3]

QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.LocalFileSubscriptionStreamReader ( IDataCacheProvider  dataCacheProvider,
string  source,
long  startingPosition 
)

Initializes a new instance of the LocalFileSubscriptionStreamReader class.

Parameters
dataCacheProviderThe IDataCacheProvider used to retrieve a stream of data
sourceThe local file to be read
startingPositionThe position in the stream from which to start reading

Definition at line 66 of file LocalFileSubscriptionStreamReader.cs.

Here is the call graph for this function:

◆ LocalFileSubscriptionStreamReader() [3/3]

QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.LocalFileSubscriptionStreamReader ( ZipFile  zipFile,
string  entryName = null 
)

Initializes a new instance of the LocalFileSubscriptionStreamReader class.

Parameters
zipFileThe local zip archive to be read
entryNameSpecifies the zip entry to be opened. Leave null if not applicable, or to open the first zip entry found regardless of name

Definition at line 87 of file LocalFileSubscriptionStreamReader.cs.

Member Function Documentation

◆ ReadLine()

string QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.ReadLine ( )

Gets the next line/batch of content from the stream

Implements QuantConnect.Interfaces.IStreamReader.

Definition at line 130 of file LocalFileSubscriptionStreamReader.cs.

◆ Dispose()

void QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.Dispose ( )

Disposes of the stream

Definition at line 138 of file LocalFileSubscriptionStreamReader.cs.

Member Data Documentation

◆ ShouldBeRateLimited

bool QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.ShouldBeRateLimited => false

Gets whether or not this stream reader should be rate limited

Definition at line 36 of file LocalFileSubscriptionStreamReader.cs.

Property Documentation

◆ StreamReader

StreamReader QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.StreamReader
get

Direct access to the StreamReader instance

Definition at line 41 of file LocalFileSubscriptionStreamReader.cs.

◆ EntryFileNames

IEnumerable<string>? QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.EntryFileNames
get

Returns the list of zip entries if local file stream reader is reading zip archive

Definition at line 104 of file LocalFileSubscriptionStreamReader.cs.

◆ TransportMedium

SubscriptionTransportMedium QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.TransportMedium
get

◆ EndOfStream

bool QuantConnect.Lean.Engine.DataFeeds.Transport.LocalFileSubscriptionStreamReader.EndOfStream
get

Gets whether or not there's more data to be read in the stream

Definition at line 123 of file LocalFileSubscriptionStreamReader.cs.


The documentation for this class was generated from the following file: