Skip to content

ObjectStoreSubscriptionStreamReader

QuantConnect.Lean.Engine.DataFeeds.Transport.ObjectStoreSubscriptionStreamReader

ObjectStoreSubscriptionStreamReader(
    object_store: IObjectStore, key: str
)

Bases: Object, IStreamReader

Represents a stream reader capable of reading lines from the object store

Initializes a new instance of the ObjectStoreSubscriptionStreamReader class.

Parameters:

Name Type Description Default
object_store IObjectStore

The IObjectStore used to retrieve a stream of data

required
key str

The object store key the data should be fetched from

required

should_be_rate_limited

should_be_rate_limited: bool

Gets whether or not this stream reader should be rate limited

stream_reader

stream_reader: StreamReader

Direct access to the StreamReader instance

transport_medium

transport_medium: SubscriptionTransportMedium

Gets SubscriptionTransportMedium.LOCAL_FILE

end_of_stream

end_of_stream: bool

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

dispose

dispose() -> None

Disposes of the stream

read_line

read_line() -> str

Gets the next line/batch of content from the stream