Class FileSystemStream
Represents a stream that can work with contents of FileSystem. This class is NOT thread-safe
Inheritance
System.Object
System.MarshalByRefObject
System.IO.Stream
FileSystemStream
Implements
System.IDisposable
Inherited Members
System.IO.Stream.Null
System.IO.Stream.BeginRead(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)
System.IO.Stream.BeginWrite(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)
System.IO.Stream.Close()
System.IO.Stream.CopyTo(System.IO.Stream)
System.IO.Stream.CopyTo(System.IO.Stream, System.Int32)
System.IO.Stream.CopyToAsync(System.IO.Stream)
System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32)
System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32, System.Threading.CancellationToken)
System.IO.Stream.CreateWaitHandle()
System.IO.Stream.Dispose()
System.IO.Stream.EndRead(System.IAsyncResult)
System.IO.Stream.EndWrite(System.IAsyncResult)
System.IO.Stream.FlushAsync()
System.IO.Stream.ObjectInvariant()
System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32)
System.IO.Stream.ReadByte()
System.IO.Stream.Synchronized(System.IO.Stream)
System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32)
System.IO.Stream.WriteByte(System.Byte)
System.IO.Stream.CanTimeout
System.IO.Stream.ReadTimeout
System.IO.Stream.WriteTimeout
System.MarshalByRefObject.GetLifetimeService()
System.MarshalByRefObject.InitializeLifetimeService()
System.MarshalByRefObject.MemberwiseClone(System.Boolean)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Azos.IO.FileSystem
Assembly: Azos.dll
Syntax
public abstract class FileSystemStream : Stream, IDisposable
Constructors
FileSystemStream(FileSystemSessionItem, Action<FileSystemStream>)
Declaration
protected FileSystemStream(FileSystemSessionItem item, Action<FileSystemStream> disposeAction)
Parameters
Type | Name | Description |
---|---|---|
FileSystemSessionItem | item | |
System.Action<FileSystemStream> | disposeAction |
Fields
Item
Item that this stream is for
Declaration
public readonly FileSystemSessionItem Item
Field Value
Type | Description |
---|---|
FileSystemSessionItem |
Properties
CanRead
Declaration
public override bool CanRead { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
System.IO.Stream.CanRead
CanSeek
Declaration
public override bool CanSeek { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
System.IO.Stream.CanSeek
CanWrite
Declaration
public override bool CanWrite { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
System.IO.Stream.CanWrite
Length
Declaration
public override sealed long Length { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
Overrides
System.IO.Stream.Length
Position
Declaration
public override sealed long Position { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
Overrides
System.IO.Stream.Position
Methods
Dispose(Boolean)
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
Overrides
System.IO.Stream.Dispose(System.Boolean)
DoFlush()
Declaration
protected abstract void DoFlush()
DoGetLength()
Declaration
protected abstract long DoGetLength()
Returns
Type | Description |
---|---|
System.Int64 |
DoGetPosition()
Declaration
protected abstract long DoGetPosition()
Returns
Type | Description |
---|---|
System.Int64 |
DoRead(Byte[], Int32, Int32)
Declaration
protected abstract int DoRead(byte[] buffer, int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | buffer | |
System.Int32 | offset | |
System.Int32 | count |
Returns
Type | Description |
---|---|
System.Int32 |
DoSeek(Int64, SeekOrigin)
Declaration
protected abstract long DoSeek(long offset, SeekOrigin origin)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | offset | |
System.IO.SeekOrigin | origin |
Returns
Type | Description |
---|---|
System.Int64 |
DoSetLength(Int64)
Declaration
protected abstract void DoSetLength(long value)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | value |
DoSetPosition(Int64)
Declaration
protected abstract void DoSetPosition(long position)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | position |
DoWrite(Byte[], Int32, Int32)
Declaration
protected abstract void DoWrite(byte[] buffer, int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | buffer | |
System.Int32 | offset | |
System.Int32 | count |
Flush()
Declaration
public override sealed void Flush()
Overrides
System.IO.Stream.Flush()
FlushAsync(CancellationToken)
Declaration
public override sealed Task FlushAsync(CancellationToken ct)
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | ct |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Overrides
System.IO.Stream.FlushAsync(System.Threading.CancellationToken)
Read(Byte[], Int32, Int32)
Declaration
public override sealed int Read(byte[] buffer, int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | buffer | |
System.Int32 | offset | |
System.Int32 | count |
Returns
Type | Description |
---|---|
System.Int32 |
Overrides
System.IO.Stream.Read(System.Byte[], System.Int32, System.Int32)
ReadAsync(Byte[], Int32, Int32, CancellationToken)
Declaration
public override sealed Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | buffer | |
System.Int32 | offset | |
System.Int32 | count | |
System.Threading.CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Int32> |
Overrides
System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)
Seek(Int64, SeekOrigin)
Declaration
public override sealed long Seek(long offset, SeekOrigin origin)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | offset | |
System.IO.SeekOrigin | origin |
Returns
Type | Description |
---|---|
System.Int64 |
Overrides
System.IO.Stream.Seek(System.Int64, System.IO.SeekOrigin)
SetLength(Int64)
Declaration
public override sealed void SetLength(long value)
Parameters
Type | Name | Description |
---|---|---|
System.Int64 | value |
Overrides
System.IO.Stream.SetLength(System.Int64)
Write(Byte[], Int32, Int32)
Declaration
public override sealed void Write(byte[] buffer, int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | buffer | |
System.Int32 | offset | |
System.Int32 | count |
Overrides
System.IO.Stream.Write(System.Byte[], System.Int32, System.Int32)
WriteAsync(Byte[], Int32, Int32, CancellationToken)
Declaration
public override sealed Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | buffer | |
System.Int32 | offset | |
System.Int32 | count | |
System.Threading.CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Overrides
System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)
Implements
System.IDisposable