Class LocalFileStream
Inherited Members
Namespace: Tenray.ZoneTree .AbstractFileStream
Assembly: ZoneTree.dll
Syntax
public sealed class LocalFileStream : Stream, IAsyncDisposable, IFileStream, IDisposable
Constructors
| Improve this Doc View SourceLocalFileStream(string, FileMode, FileAccess, FileShare, int, FileOptions)
Declaration
public LocalFileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options)
Parameters
Type | Name | Description |
---|---|---|
string | path | |
File |
mode | |
File |
access | |
File |
share | |
int | bufferSize | |
File |
options |
Properties
| Improve this Doc View SourceCanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
Declaration
public override bool CanRead { get; }
Property Value
Overrides
| Improve this Doc View SourceCanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
Declaration
public override bool CanSeek { get; }
Property Value
Overrides
| Improve this Doc View SourceCanTimeout
Gets a value that determines whether the current stream can time out.
Declaration
public override bool CanTimeout { get; }
Property Value
Type | Description |
---|---|
bool | A value that determines whether the current stream can time out. |
Overrides
| Improve this Doc View SourceCanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
Declaration
public override bool CanWrite { get; }
Property Value
Overrides
| Improve this Doc View SourceFilePath
Declaration
public string FilePath { get; }
Property Value
Type | Description |
---|---|
string |
Length
When overridden in a derived class, gets the length in bytes of the stream.
Declaration
public override long Length { get; }
Property Value
Type | Description |
---|---|
long | A long value representing the length of the stream in bytes. |
Overrides
Exceptions
Type | Condition |
---|---|
Not |
A class derived from |
Object |
Methods were called after the stream was closed. |
Position
When overridden in a derived class, gets or sets the position within the current stream.
Declaration
public override long Position { get; set; }
Property Value
Type | Description |
---|---|
long | The current position within the stream. |
Overrides
Exceptions
Type | Condition |
---|---|
IOException | An I/O error occurs. |
Not |
The stream does not support seeking. |
Object |
Methods were called after the stream was closed. |
ReadTimeout
Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
Declaration
public override int ReadTimeout { get; set; }
Property Value
Type | Description |
---|---|
int | A value, in milliseconds, that determines how long the stream will attempt to read before timing out. |
Overrides
Exceptions
Type | Condition |
---|---|
Invalid |
The Read |
WriteTimeout
Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
Declaration
public override int WriteTimeout { get; set; }
Property Value
Type | Description |
---|---|
int | A value, in milliseconds, that determines how long the stream will attempt to write before timing out. |
Overrides
Exceptions
Type | Condition |
---|---|
Invalid |
The Write |
Methods
| Improve this Doc View SourceBeginRead(byte[], int, int, AsyncCallback, object)
Begins an asynchronous read operation. (Consider using Read
Declaration
public override IAsyncResult BeginRead(byte[] buffer, int offset, int count, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The buffer to read the data into. |
int | offset | The byte offset in |
int | count | The maximum number of bytes to read. |
Async |
callback | An optional asynchronous callback, to be called when the read is complete. |
object | state | A user-provided object that distinguishes this particular asynchronous read request from other requests. |
Returns
Type | Description |
---|---|
IAsync |
An IAsync |
Overrides
Exceptions
Type | Condition |
---|---|
IOException | Attempted an asynchronous read past the end of the stream, or a disk error occurs. |
Argument |
One or more of the arguments is invalid. |
Object |
Methods were called after the stream was closed. |
Not |
The current |
BeginWrite(byte[], int, int, AsyncCallback, object)
Begins an asynchronous write operation. (Consider using Write
Declaration
public override IAsyncResult BeginWrite(byte[] buffer, int offset, int count, AsyncCallback callback, object state)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The buffer to write data from. |
int | offset | The byte offset in |
int | count | The maximum number of bytes to write. |
Async |
callback | An optional asynchronous callback, to be called when the write is complete. |
object | state | A user-provided object that distinguishes this particular asynchronous write request from other requests. |
Returns
Type | Description |
---|---|
IAsync |
An |
Overrides
Exceptions
Type | Condition |
---|---|
IOException | Attempted an asynchronous write past the end of the stream, or a disk error occurs. |
Argument |
One or more of the arguments is invalid. |
Object |
Methods were called after the stream was closed. |
Not |
The current |
Close()
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.
Declaration
public override void Close()
Overrides
| Improve this Doc View SourceCopyTo(Stream, int)
Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied.
Declaration
public override void CopyTo(Stream destination, int bufferSize)
Parameters
Type | Name | Description |
---|---|---|
Stream | destination | The stream to which the contents of the current stream will be copied. |
int | bufferSize | The size of the buffer. This value must be greater than zero. The default size is 81920. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
|
Argument |
|
Not |
The current stream does not support reading. -or-
|
Object |
Either the current stream or |
IOException | An I/O error occurred. |
CopyToAsync(Stream, int, CancellationToken)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied.
Declaration
public override Task CopyToAsync(Stream destination, int bufferSize, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
Stream | destination | The stream to which the contents of the current stream will be copied. |
int | bufferSize | The size, in bytes, of the buffer. This value must be greater than zero. The default size is 81920. |
Cancellation |
cancellationToken | The token to monitor for cancellation requests. The default value is None. |
Returns
Type | Description |
---|---|
Task | A task that represents the asynchronous copy operation. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
|
Argument |
|
Object |
Either the current stream or the destination stream is disposed. |
Not |
The current stream does not support reading, or the destination stream does not support writing. |
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
Dispose(bool)
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true to release both managed and unmanaged resources; false to release only unmanaged resources. |
Overrides
| Improve this Doc View SourceDisposeAsync()
Asynchronously releases the unmanaged resources used by the Stream.
Declaration
public override ValueTask DisposeAsync()
Returns
Type | Description |
---|---|
Value |
A task that represents the asynchronous dispose operation. |
Overrides
| Improve this Doc View SourceEndRead(IAsyncResult)
Waits for the pending asynchronous read to complete. (Consider using Read
Declaration
public override int EndRead(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
IAsync |
asyncResult | The reference to the pending asynchronous request to finish. |
Returns
Type | Description |
---|---|
int | The number of bytes read from the stream, between zero (0) and the number of bytes you requested. Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is available. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
|
Argument |
A handle to the pending read operation is not available. -or- The pending operation does not support reading. |
Invalid |
|
IOException | The stream is closed or an internal error has occurred. |
EndWrite(IAsyncResult)
Ends an asynchronous write operation. (Consider using Write
Declaration
public override void EndWrite(IAsyncResult asyncResult)
Parameters
Type | Name | Description |
---|---|---|
IAsync |
asyncResult | A reference to the outstanding asynchronous I/O request. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
|
Argument |
A handle to the pending write operation is not available. -or- The pending operation does not support writing. |
Invalid |
|
IOException | The stream is closed or an internal error has occurred. |
Flush()
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
Declaration
public override void Flush()
Overrides
Exceptions
Type | Condition |
---|---|
IOException | An I/O error occurs. |
Flush(bool)
Declaration
public void Flush(bool flushToDisk)
Parameters
Type | Name | Description |
---|---|---|
bool | flushToDisk |
FlushAsync(CancellationToken)
Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
Declaration
public override Task FlushAsync(CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
Cancellation |
cancellationToken | The token to monitor for cancellation requests. The default value is None. |
Returns
Type | Description |
---|---|
Task | A task that represents the asynchronous flush operation. |
Overrides
Exceptions
Type | Condition |
---|---|
Object |
The stream has been disposed. |
Read(byte[], int, 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.
Declaration
public override int Read(byte[] buffer, int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | An array of bytes. When this method returns, the buffer contains the specified byte array with the values between |
int | offset | The zero-based byte offset in |
int | count | The maximum number of bytes to be read from the current stream. |
Returns
Type | Description |
---|---|
int | The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
The sum of |
Argument |
|
Argument |
|
IOException | An I/O error occurs. |
Not |
The stream does not support reading. |
Object |
Methods were called after the stream was closed. |
Read(Span<byte>)
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.
Declaration
public override int Read(Span<byte> buffer)
Parameters
Type | Name | Description |
---|---|---|
Span<byte> | buffer | A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source. |
Returns
Type | Description |
---|---|
int | The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. |
Overrides
| Improve this Doc View SourceReadAsync(byte[], int, int, CancellationToken)
Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
Declaration
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The buffer to write the data into. |
int | offset | The byte offset in |
int | count | The maximum number of bytes to read. |
Cancellation |
cancellationToken | The token to monitor for cancellation requests. The default value is None. |
Returns
Type | Description |
---|---|
Task<int> | A task that represents the asynchronous read operation. The value of the |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
|
Argument |
|
Argument |
The sum of |
Not |
The stream does not support reading. |
Object |
The stream has been disposed. |
Invalid |
The stream is currently in use by a previous read operation. |
ReadAsync(Memory<byte>, CancellationToken)
Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
Declaration
public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Memory<byte> | buffer | The region of memory to write the data into. |
Cancellation |
cancellationToken | The token to monitor for cancellation requests. The default value is None. |
Returns
Type | Description |
---|---|
Value |
A task that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached. |
Overrides
| Improve this Doc View SourceReadByte()
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
Declaration
public override int ReadByte()
Returns
Overrides
Exceptions
Type | Condition |
---|---|
Not |
The stream does not support reading. |
Object |
Methods were called after the stream was closed. |
ReadFaster(byte[], int, int)
Custom ReadExactly method that does not use internal buffer.
Declaration
public int ReadFaster(byte[] buffer, int offset, int count)
Parameters
Returns
Type | Description |
---|---|
int |
Seek(long, SeekOrigin)
When overridden in a derived class, sets the position within the current stream.
Declaration
public override long Seek(long offset, SeekOrigin origin)
Parameters
Type | Name | Description |
---|---|---|
long | offset | A byte offset relative to the |
Seek |
origin | A value of type Seek |
Returns
Type | Description |
---|---|
long | The new position within the current stream. |
Overrides
Exceptions
Type | Condition |
---|---|
IOException | An I/O error occurs. |
Not |
The stream does not support seeking, such as if the stream is constructed from a pipe or console output. |
Object |
Methods were called after the stream was closed. |
SetLength(long)
When overridden in a derived class, sets the length of the current stream.
Declaration
public override void SetLength(long value)
Parameters
Type | Name | Description |
---|---|---|
long | value | The desired length of the current stream in bytes. |
Overrides
Exceptions
Type | Condition |
---|---|
IOException | An I/O error occurs. |
Not |
The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. |
Object |
Methods were called after the stream was closed. |
ToStream()
Declaration
public Stream ToStream()
Returns
Type | Description |
---|---|
Stream |
Write(byte[], int, int)
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.
Declaration
public override void Write(byte[] buffer, int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | An array of bytes. This method copies |
int | offset | The zero-based byte offset in |
int | count | The number of bytes to be written to the current stream. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
The sum of |
Argument |
|
Argument |
|
IOException | An I/O error occurred, such as the specified file cannot be found. |
Not |
The stream does not support writing. |
Object |
Write(byte[], int, int) was called after the stream was closed. |
Write(ReadOnlySpan<byte>)
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.
Declaration
public override void Write(ReadOnlySpan<byte> buffer)
Parameters
Type | Name | Description |
---|---|---|
Read |
buffer | A region of memory. This method copies the contents of this region to the current stream. |
Overrides
| Improve this Doc View SourceWriteAsync(byte[], int, int, CancellationToken)
Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
Declaration
public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The buffer to write data from. |
int | offset | The zero-based byte offset in |
int | count | The maximum number of bytes to write. |
Cancellation |
cancellationToken | The token to monitor for cancellation requests. The default value is None. |
Returns
Type | Description |
---|---|
Task | A task that represents the asynchronous write operation. |
Overrides
Exceptions
Type | Condition |
---|---|
Argument |
|
Argument |
|
Argument |
The sum of |
Not |
The stream does not support writing. |
Object |
The stream has been disposed. |
Invalid |
The stream is currently in use by a previous write operation. |
WriteAsync(ReadOnlyMemory<byte>, CancellationToken)
Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
Declaration
public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
Read |
buffer | The region of memory to write data from. |
Cancellation |
cancellationToken | The token to monitor for cancellation requests. The default value is None. |
Returns
Type | Description |
---|---|
Value |
A task that represents the asynchronous write operation. |
Overrides
| Improve this Doc View SourceWriteByte(byte)
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
Declaration
public override void WriteByte(byte value)
Parameters
Type | Name | Description |
---|---|---|
byte | value | The byte to write to the stream. |
Overrides
Exceptions
Type | Condition |
---|---|
IOException | An I/O error occurs. |
Not |
The stream does not support writing, or the stream is already closed. |
Object |
Methods were called after the stream was closed. |