C# Class Microsoft.CodeAnalysis.Sarif.Driver.RentalStream

"Rental" stream. Wraps a stream object, but prevents the client from calling dispose on that stream object. This allows a stream to be passed, for example to TextReader or TextWriter, without giving up ownership of the underlying stream.

Inheritance: Stream

Mostra file Open project: Microsoft/sarif-sdk

Public Methods

Method	Description
Flush ( ) : void	When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
Read ( byte buffer, int offset, int count ) : int	When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
RentalStream ( Stream sourceStream ) : System	Initializes a new instance of the RentalStream class.
Seek ( long offset, SeekOrigin origin ) : long	When overridden in a derived class, sets the position within the current stream.
SetLength ( long value ) : void	When overridden in a derived class, sets the length of the current stream.
Write ( byte buffer, int offset, int count ) : void	When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Private Methods

Method	Description
Dispose ( bool disposing ) : void

Method Details

Flush() public method

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

An I/O error occurs.

public Flush ( ) : void
return	void

Read() public method

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

The sum of and /// is larger than the buffer length. is null. or /// is negative. An I/O error occurs. The stream does not support reading. Methods were called after the stream /// was closed.

public Read ( byte buffer, int offset, int count ) : int
buffer	byte	An array of bytes. When this method returns, the buffer contains the /// specified byte array with the values between and /// ( + - 1) replaced by the bytes read from /// the current source.
offset	int	The zero-based byte offset in at which to /// begin storing the data read from the current stream.
count	int	The maximum number of bytes to be read from the current stream.
return	int

RentalStream() public method

Initializes a new instance of the RentalStream class.

public RentalStream ( Stream sourceStream ) : System
sourceStream	Stream	The Stream to process.
return	System

Seek() public method

When overridden in a derived class, sets the position within the current stream.

An I/O error occurs. The stream does not support seeking, such /// as if the stream is constructed from a pipe or console output. Methods were called after the stream /// was closed.

public Seek ( long offset, SeekOrigin origin ) : long
offset	long	A byte offset relative to the parameter.
origin	SeekOrigin	A value of type indicating the /// reference point used to obtain the new position.
return	long

SetLength() public method

When overridden in a derived class, sets the length of the current stream.

An I/O error occurs. The stream does not support both writing /// and seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream /// was closed.

public SetLength ( long value ) : void
value	long	The desired length of the current stream in bytes.
return	void

Write() public method

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

The sum of and /// is greater than the buffer length. is null. or /// is negative. An I/O error occurs. The stream does not support writing. Methods were called after the stream /// was closed.

public Write ( byte buffer, int offset, int count ) : void
buffer	byte	An array of bytes. This method copies bytes /// from to the current stream.
offset	int	The zero-based byte offset in at which to /// begin copying bytes to the current stream.
count	int	The number of bytes to be written to the current stream.
return	void