Interface IFileStream

Inherited Members

Namespace: Tenray.ZoneTree.AbstractFileStream

Assembly: ZoneTree.dll

Syntax

public interface IFileStream : IDisposable

Properties

| Improve this Doc View Source

CanRead

Declaration

bool CanRead { get; }

Property Value

Type	Description
bool

| Improve this Doc View Source

CanSeek

Declaration

bool CanSeek { get; }

Property Value

Type	Description
bool

| Improve this Doc View Source

CanTimeout

Declaration

bool CanTimeout { get; }

Property Value

Type	Description
bool

| Improve this Doc View Source

CanWrite

Declaration

bool CanWrite { get; }

Property Value

Type	Description
bool

| Improve this Doc View Source

FilePath

Declaration

string FilePath { get; }

Property Value

Type	Description
string

| Improve this Doc View Source

Length

Declaration

long Length { get; }

Property Value

Type	Description
long

| Improve this Doc View Source

Position

Declaration

long Position { get; set; }

Property Value

Type	Description
long

| Improve this Doc View Source

ReadTimeout

Declaration

int ReadTimeout { get; set; }

Property Value

Type	Description
int

| Improve this Doc View Source

WriteTimeout

Declaration

int WriteTimeout { get; set; }

Property Value

Type	Description
int

Methods

| Improve this Doc View Source

BeginRead(byte[], int, int, AsyncCallback, object)

Declaration

IAsyncResult BeginRead(byte[] buffer, int offset, int count, AsyncCallback callback, object state)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count
AsyncCallback	callback
object	state

Returns

Type	Description
IAsyncResult

| Improve this Doc View Source

BeginWrite(byte[], int, int, AsyncCallback, object)

Declaration

IAsyncResult BeginWrite(byte[] buffer, int offset, int count, AsyncCallback callback, object state)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count
AsyncCallback	callback
object	state

Returns

Type	Description
IAsyncResult

| Improve this Doc View Source

Close()

Declaration

void Close()

| Improve this Doc View Source

CopyTo(Stream)

Declaration

void CopyTo(Stream destination)

Parameters

Type	Name	Description
Stream	destination

| Improve this Doc View Source

CopyTo(Stream, int)

Declaration

void CopyTo(Stream destination, int bufferSize)

Parameters

Type	Name	Description
Stream	destination
int	bufferSize

| Improve this Doc View Source

CopyToAsync(Stream)

Declaration

Task CopyToAsync(Stream destination)

Parameters

Type	Name	Description
Stream	destination

Returns

Type	Description
Task

| Improve this Doc View Source

CopyToAsync(Stream, int)

Declaration

Task CopyToAsync(Stream destination, int bufferSize)

Parameters

Type	Name	Description
Stream	destination
int	bufferSize

Returns

Type	Description
Task

| Improve this Doc View Source

CopyToAsync(Stream, int, CancellationToken)

Declaration

Task CopyToAsync(Stream destination, int bufferSize, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Stream	destination
int	bufferSize
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Improve this Doc View Source

CopyToAsync(Stream, CancellationToken)

Declaration

Task CopyToAsync(Stream destination, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Stream	destination
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Improve this Doc View Source

DisposeAsync()

Declaration

ValueTask DisposeAsync()

Returns

Type	Description
ValueTask

| Improve this Doc View Source

EndRead(IAsyncResult)

Declaration

int EndRead(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult

Returns

Type	Description
int

| Improve this Doc View Source

EndWrite(IAsyncResult)

Declaration

void EndWrite(IAsyncResult asyncResult)

Parameters

Type	Name	Description
IAsyncResult	asyncResult

| Improve this Doc View Source

Flush()

Declaration

void Flush()

| Improve this Doc View Source

Flush(bool)

Declaration

void Flush(bool flushToDisk)

Parameters

Type	Name	Description
bool	flushToDisk

| Improve this Doc View Source

FlushAsync()

Declaration

Task FlushAsync()

Returns

Type	Description
Task

| Improve this Doc View Source

FlushAsync(CancellationToken)

Declaration

Task FlushAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Improve this Doc View Source

Read(byte[], int, int)

Declaration

int Read(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count

Returns

Type	Description
int

| Improve this Doc View Source

Read(Span<byte>)

Declaration

int Read(Span<byte> buffer)

Parameters

Type	Name	Description
Span<byte>	buffer

Returns

Type	Description
int

| Improve this Doc View Source

ReadAsync(byte[], int, int)

Declaration

Task<int> ReadAsync(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count

Returns

Type	Description
Task<int>

| Improve this Doc View Source

ReadAsync(byte[], int, int, CancellationToken)

Declaration

Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count
CancellationToken	cancellationToken

Returns

Type	Description
Task<int>

| Improve this Doc View Source

ReadAsync(Memory<byte>, CancellationToken)

Declaration

ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Memory<byte>	buffer
CancellationToken	cancellationToken

Returns

Type	Description
ValueTask<int>

| Improve this Doc View Source

ReadByte()

Declaration

int ReadByte()

Returns

Type	Description
int

| Improve this Doc View Source

ReadFaster(byte[], int, int)

Custom ReadExactly method that does not use internal buffer.

Declaration

int ReadFaster(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count

Returns

Type	Description
int

| Improve this Doc View Source

Seek(long, SeekOrigin)

Declaration

long Seek(long offset, SeekOrigin origin)

Parameters

Type	Name	Description
long	offset
SeekOrigin	origin

Returns

Type	Description
long

| Improve this Doc View Source

SetLength(long)

Declaration

void SetLength(long value)

Parameters

Type	Name	Description
long	value

| Improve this Doc View Source

ToStream()

Declaration

Stream ToStream()

Returns

Type	Description
Stream

| Improve this Doc View Source

Write(byte[], int, int)

Declaration

void Write(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count

| Improve this Doc View Source

Write(ReadOnlySpan<byte>)

Declaration

void Write(ReadOnlySpan<byte> buffer)

Parameters

Type	Name	Description
ReadOnlySpan<byte>	buffer

| Improve this Doc View Source

WriteAsync(byte[], int, int)

Declaration

Task WriteAsync(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count

Returns

Type	Description
Task

| Improve this Doc View Source

WriteAsync(byte[], int, int, CancellationToken)

Declaration

Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Parameters

Type	Name	Description
byte[]	buffer
int	offset
int	count
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Improve this Doc View Source

WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Declaration

ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ReadOnlyMemory<byte>	buffer
CancellationToken	cancellationToken

Returns

Type	Description
ValueTask

| Improve this Doc View Source

WriteByte(byte)

Declaration

void WriteByte(byte value)

Parameters

Type	Name	Description
byte	value