Lean  $LEAN_TAG$
QuantConnect.ZipStreamWriter Class Reference

Provides an implementation of TextWriter to write to a zip file More...

Inheritance diagram for QuantConnect.ZipStreamWriter:
[legend]

Public Member Functions

 ZipStreamWriter (string filename, string zipEntry)
 Initializes a new instance of the ZipStreamWriter class More...
 
override void Write (char value)
 Writes a character to the text string or stream. More...
 
override void WriteLine (string value)
 Writes a string followed by a line terminator to the text string or stream. More...
 
override void Flush ()
 Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. More...
 

Public Attributes

override Encoding Encoding => Encoding.Default
 When overridden in a derived class, returns the character encoding in which the output is written. More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Releases the unmanaged resources used by the T:System.IO.TextWriter and optionally releases the managed resources. More...
 

Detailed Description

Provides an implementation of TextWriter to write to a zip file

Definition at line 25 of file ZipStreamWriter.cs.

Constructor & Destructor Documentation

◆ ZipStreamWriter()

QuantConnect.ZipStreamWriter.ZipStreamWriter ( string  filename,
string  zipEntry 
)

Initializes a new instance of the ZipStreamWriter class

Parameters
filenameThe output zip file name
zipEntryThe file name in the zip file

Definition at line 44 of file ZipStreamWriter.cs.

Member Function Documentation

◆ Write()

override void QuantConnect.ZipStreamWriter.Write ( char  value)

Writes a character to the text string or stream.

Parameters
valueThe character to write to the text stream.
Exceptions
T:System.ObjectDisposedExceptionThe T:System.IO.TextWriter is closed.
T:System.IO.IOExceptionAn I/O error occurs.

<filterpriority>1</filterpriority>

Definition at line 78 of file ZipStreamWriter.cs.

◆ WriteLine()

override void QuantConnect.ZipStreamWriter.WriteLine ( string  value)

Writes a string followed by a line terminator to the text string or stream.

Parameters
valueThe string to write. If value is null, only the line terminator is written.
Exceptions
T:System.ObjectDisposedExceptionThe T:System.IO.TextWriter is closed.
T:System.IO.IOExceptionAn I/O error occurs.

<filterpriority>1</filterpriority>

Definition at line 90 of file ZipStreamWriter.cs.

◆ Flush()

override void QuantConnect.ZipStreamWriter.Flush ( )

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.

Definition at line 98 of file ZipStreamWriter.cs.

◆ Dispose()

override void QuantConnect.ZipStreamWriter.Dispose ( bool  disposing)
protected

Releases the unmanaged resources used by the T:System.IO.TextWriter and optionally releases the managed resources.

Parameters
disposingtrue to release both managed and unmanaged resources; false to release only unmanaged resources.

Definition at line 107 of file ZipStreamWriter.cs.

Member Data Documentation

◆ Encoding

override Encoding QuantConnect.ZipStreamWriter.Encoding => Encoding.Default

When overridden in a derived class, returns the character encoding in which the output is written.

Returns
The character encoding in which the output is written.

<filterpriority>1</filterpriority>

Definition at line 37 of file ZipStreamWriter.cs.


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