StreamReaderExtensions

QuantConnect.Util.StreamReaderExtensions

Bases: Object

Extension methods to fetch data from a StreamReader instance

get_decimal

get_decimal(
    stream: StreamReader, delimiter: str = ...
) -> float

get_decimal(
    stream: StreamReader,
    past_end_line: Optional[bool],
    delimiter: str = ...,
) -> Tuple[float, bool]

Gets a decimal from the provided stream reader

Parameters:

Name	Type	Description	Default
stream	StreamReader	The data stream	required
delimiter	str	The data delimiter character to use, default is ','	...
past_end_line	Optional[Optional[bool]]	True if end line was past, useful for consumers to know a line ended	None

Returns:

Type	Description
float | Tuple[float, bool]	The decimal read from the stream.

get_char

get_char(stream: StreamReader, delimiter: str = ...) -> str

Gets a character from a stream reader

Parameters:

Name	Type	Description	Default
stream	StreamReader	The data stream	required
delimiter	str	The data delimiter character to use, default is ','	...

Returns:

Type	Description
str	The string instance read.

get_date_time

get_date_time(
    stream: StreamReader,
    format: str = ...,
    delimiter: str = ...,
) -> datetime

Gets a date time instance from a stream reader

Parameters:

Name	Type	Description	Default
stream	StreamReader	The data stream	required
format	str	The format in which the date time is	...
delimiter	str	The data delimiter character to use, default is ','	...

Returns:

Type	Description
datetime	The date time instance read.

get_int_32

get_int_32(
    stream: StreamReader, delimiter: str = ...
) -> int

Gets an integer from a stream reader

Parameters:

Name	Type	Description	Default
stream	StreamReader	The data stream	required
delimiter	str	The data delimiter character to use, default is ','	...

Returns:

Type	Description
int	The integer instance read.

get_string

get_string(
    stream: StreamReader, delimiter: str = ...
) -> str

Gets a string from a stream reader

Parameters:

Name	Type	Description	Default
stream	StreamReader	The data stream	required
delimiter	str	The data delimiter character to use, default is ','	...

Returns:

Type	Description
str	The string instance read.