Exposes a System.IO.Stream around a remote SFTP file, supporting both synchronous and asynchronous read and write operations.
public class SftpFileStream : Stream, IAsyncDisposable, IDisposableGets a value indicating whether the current stream supports reading.
public override bool CanRead { get; }Gets a value indicating whether the current stream supports seeking.
public override bool CanSeek { get; }Gets a value indicating whether timeout properties are usable for Renci.SshNet.Sftp.SftpFileStream.
public override bool CanTimeout { get; }Gets a value indicating whether the current stream supports writing.
public override bool CanWrite { get; }Gets the operating system file handle for the file that the current Renci.SshNet.Sftp.SftpFileStream encapsulates.
public virtual byte[] Handle { get; }Gets the length in bytes of the stream.
public override long Length { get; }A class derived from Stream does not support seeking.
Methods were called after the stream was closed.
IO operation failed.
Gets the name of the path that was used to construct the current Renci.SshNet.Sftp.SftpFileStream.
public string Name { get; }Gets or sets the position within the current stream.
public override long Position { get; set; }An I/O error occurs.
The stream does not support seeking.
Methods were called after the stream was closed.
Gets or sets the operation timeout.
public TimeSpan Timeout { get; set; }Releases the unmanaged resources used by the System.IO.Stream and optionally releases the managed resources.
protected override void Dispose(bool disposing)disposing bool
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Clears all buffers for this stream and causes any buffered data to be written to the file.
public override void Flush()An I/O error occurs.
Stream is closed.
Asynchronously clears all buffers for this stream and causes any buffered data to be written to the file.
public override Task FlushAsync(CancellationToken cancellationToken)cancellationToken CancellationToken
The System.Threading.CancellationToken to observe.
A System.Threading.Tasks.Task that represents the asynchronous flush operation.
An I/O error occurs.
Stream is closed.
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
public override int Read(byte[] buffer, int offset, int count)buffer byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset int
The zero-based byte offset in buffer 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.
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.
This method attempts to read up to count bytes. This either from the buffer, from the server (using one or more SSH_FXP_READ requests) or using a combination of both.
The read loop is interrupted when either count bytes are read, the server returns zero bytes (EOF) or less bytes than the read buffer size.
When a server returns less number of bytes than the read buffer size, this may indicate that EOF has been reached. A subsequent (SSH_FXP_READ) server request is necessary to make sure EOF has effectively been reached. Breaking out of the read loop avoids reading from the server twice to determine EOF: once in the read loop, and once upon the next Renci.SshNet.Sftp.SftpFileStream.Read(System.Byte[],System.Int32,System.Int32) or Renci.SshNet.Sftp.SftpFileStream.ReadByte invocation.
The sum of offset and count is larger than the buffer length.
buffer is null.
offset or count is negative.
An I/O error occurs.
The stream does not support reading.
Methods were called after the stream was closed.
Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)buffer byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset int
The zero-based byte offset in buffer 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.
cancellationToken CancellationToken
The System.Threading.CancellationToken to observe.
A System.Threading.Tasks.Task that represents the asynchronous read operation.
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.
public override int ReadByte()The unsigned byte cast to an System.Int32, or -1 if at the end of the stream.
The stream does not support reading.
Methods were called after the stream was closed.
Read operation failed.
Sets the position within the current stream.
public override long Seek(long offset, SeekOrigin origin)offset long
A byte offset relative to the origin parameter.
origin SeekOrigin
A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.
The new 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.
Sets the length of the current stream.
public override void SetLength(long value)value long
The desired length of the current stream in bytes.
Buffers are first flushed.
If the specified value is less than the current length of the stream, the stream is truncated and - if the current position is greater than the new length - the current position is moved to the last byte of the stream.
If the given value is greater than the current length of the stream, the stream is expanded and the current position remains the same.
ExceptionsAn I/O error occurs.
The stream does not support both writing and seeking.
Methods were called after the stream was closed.
value must be greater than zero.
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
public override void Write(byte[] buffer, int offset, int count)buffer byte[]
An array of bytes. This method copies count bytes from buffer to the current stream.
offset int
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count int
The number of bytes to be written to the current stream.
The sum of offset and count is greater than the buffer length.
buffer is null.
offset or count is negative.
An I/O error occurs.
The stream does not support writing.
Methods were called after the stream was closed.
Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)buffer byte[]
An array of bytes. This method copies count bytes from buffer to the current stream.
offset int
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count int
The number of bytes to be written to the current stream.
cancellationToken CancellationToken
The System.Threading.CancellationToken to observe.
A System.Threading.Tasks.Task that represents the asynchronous write operation.
The sum of offset and count is greater than the buffer length.
buffer is null.
offset or count is negative.
An I/O error occurs.
The stream does not support writing.
Methods were called after the stream was closed.
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
public override void WriteByte(byte value)value byte
The byte to write to the stream.
An I/O error occurs.
The stream does not support writing, or the stream is already closed.
Methods were called after the stream was closed.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4