A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://dotnet.github.io/dotNext/api/DotNext.IO.FileReader.html below:

Class FileReader | .NEXT

Class FileReader

Represents buffered file reader.

Namespace: DotNext.IO Assembly: DotNext.IO.dll Syntax
public class FileReader : Disposable, IAsyncBinaryReader, IBufferedReader, IBufferedChannel, IResettable, IDisposable, IAsyncEnumerable<ReadOnlyMemory<byte>>, IDynamicInterfaceCastable
Constructors | Edit this page View Source FileReader(SafeFileHandle)

Initializes a new buffered file reader.

Declaration
public FileReader(SafeFileHandle handle)
Parameters Exceptions | Edit this page View Source FileReader(FileStream)

Initializes a new buffered file reader.

Declaration
public FileReader(FileStream source)
Parameters Type Name Description FileStream source

Readable file stream.

Exceptions Fields | Edit this page View Source handle

Represents the file handle.

Declaration
protected readonly SafeFileHandle handle
Field Value Properties | Edit this page View Source Allocator

Gets buffer allocator.

Declaration
public MemoryAllocator<byte>? Allocator { get; init; }
Property Value | Edit this page View Source Buffer

Gets unconsumed part of the buffer.

Declaration
public ReadOnlyMemory<byte> Buffer { get; }
Property Value | Edit this page View Source FilePosition

Gets or sets the cursor position within the file.

Declaration
public long FilePosition { get; set; }
Property Value Exceptions | Edit this page View Source HasBufferedData

Gets a value indicating that the read buffer is not empty.

Declaration
public bool HasBufferedData { get; }
Property Value | Edit this page View Source MaxBufferSize

Gets the maximum size of the internal buffer.

Declaration
public int MaxBufferSize { get; init; }
Property Value | Edit this page View Source ReadPosition

Gets the read position within the file.

Declaration
public long ReadPosition { get; }
Property Value | Edit this page View Source ReaderSegmentLength

Limits the number of available bytes to read.

Declaration
public long? ReaderSegmentLength { set; }
Property Value Type Description long?

The number of available bytes to read; or null to allow read to the end of the file.

Exceptions Methods | Edit this page View Source Consume(int)

Advances read position.

Declaration
public void Consume(int count)
Parameters Type Name Description int count

The number of consumed bytes.

Exceptions | Edit this page View Source CopyToAsync<TConsumer>(TConsumer, long, CancellationToken)

Reads the entire content using the specified delegate.

Declaration
public ValueTask CopyToAsync<TConsumer>(TConsumer consumer, long count, CancellationToken token = default) where TConsumer : ISupplier<ReadOnlyMemory<byte>, CancellationToken, ValueTask>
Parameters Type Name Description TConsumer consumer

The content reader.

long count

The number of bytes to copy.

CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask

The task representing asynchronous result.

Type Parameters Name Description TConsumer

The type of the consumer.

Exceptions | Edit this page View Source CopyToAsync<TConsumer>(TConsumer, CancellationToken)

Reads the entire content using the specified delegate.

Declaration
public ValueTask CopyToAsync<TConsumer>(TConsumer consumer, CancellationToken token = default) where TConsumer : ISupplier<ReadOnlyMemory<byte>, CancellationToken, ValueTask>
Parameters Type Name Description TConsumer consumer

The content reader.

CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask

The task representing asynchronous result.

Type Parameters Name Description TConsumer

The type of the consumer.

Exceptions | Edit this page View Source DecodeAsync(DecodingContext, LengthFormat, MemoryAllocator<char>?, CancellationToken)

Decodes the sequence of characters.

Declaration
public ValueTask<MemoryOwner<char>> DecodeAsync(DecodingContext context, LengthFormat lengthFormat, MemoryAllocator<char>? allocator = null, CancellationToken token = default)
Parameters Type Name Description DecodingContext context

The decoding context containing string characters encoding.

LengthFormat lengthFormat

The format of the string length encoded in the stream.

MemoryAllocator<char> allocator

The allocator of the buffer of characters.

CancellationToken token

The token that can be used to cancel the operation.

Returns Exceptions | Edit this page View Source DecodeAsync(DecodingContext, LengthFormat, Memory<char>, CancellationToken)

Decodes the sequence of characters.

Declaration
public IAsyncEnumerable<ReadOnlyMemory<char>> DecodeAsync(DecodingContext context, LengthFormat lengthFormat, Memory<char> buffer, CancellationToken token = default)
Parameters Type Name Description DecodingContext context

The decoding context containing string characters encoding.

LengthFormat lengthFormat

The format of the string length encoded in the stream.

Memory<char> buffer

The buffer of characters.

CancellationToken token

The token that can be used to cancel the operation.

Returns Exceptions | Edit this page View Source Dispose(bool)

Releases managed and unmanaged resources associated with this object.

Declaration
protected override void Dispose(bool disposing)
Parameters Overrides | Edit this page View Source ParseAsync<T>(LengthFormat, NumberStyles, IFormatProvider?, CancellationToken)

Parses the numeric value from UTF-8 encoded characters.

Declaration
public ValueTask<T> ParseAsync<T>(LengthFormat lengthFormat, NumberStyles style, IFormatProvider? provider = null, CancellationToken token = default) where T : INumberBase<T>
Parameters Type Name Description LengthFormat lengthFormat

The format of the string length (in bytes) encoded in the stream.

NumberStyles style

A combination of number styles.

IFormatProvider provider

Culture-specific formatting information.

CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<T>

The result of parsing.

Type Parameters Name Description T

The numeric type.

Exceptions | Edit this page View Source ParseAsync<T>(LengthFormat, IFormatProvider?, CancellationToken)

Parses the sequence of characters encoded as UTF-8.

Declaration
public ValueTask<T> ParseAsync<T>(LengthFormat lengthFormat, IFormatProvider? provider = null, CancellationToken token = default) where T : IUtf8SpanParsable<T>
Parameters Type Name Description LengthFormat lengthFormat

The format of the string length (in bytes) encoded in the stream.

IFormatProvider provider

Culture-specific formatting information.

CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<T>

The result of parsing.

Type Parameters Name Description T

The type that supports parsing from UTF-8.

Exceptions | Edit this page View Source Read()

Reads the data from the file to the underlying buffer.

Declaration Returns Type Description bool

true if the data has been copied from the file to the internal buffer; false if no more data to read.

Exceptions | Edit this page View Source Read(Span<byte>)

Reads the block of the memory.

Declaration
public int Read(Span<byte> destination)
Parameters Type Name Description Span<byte> destination

The output buffer.

Returns Type Description int

The number of bytes copied to destination.

Exceptions | Edit this page View Source ReadAsync(LengthFormat, MemoryAllocator<byte>?, CancellationToken)

Reads the memory block.

Declaration
public ValueTask<MemoryOwner<byte>> ReadAsync(LengthFormat lengthFormat, MemoryAllocator<byte>? allocator = null, CancellationToken token = default)
Parameters Type Name Description LengthFormat lengthFormat

The format of the string length encoded in the stream.

MemoryAllocator<byte> allocator

An allocator of the resulting buffer.

CancellationToken token

The token that can be used to cancel the operation.

Returns Exceptions | Edit this page View Source ReadAsync(Memory<byte>, CancellationToken)

Reads the block of the memory.

Declaration
public ValueTask<int> ReadAsync(Memory<byte> destination, CancellationToken token = default)
Parameters Type Name Description Memory<byte> destination

The output buffer.

CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<int>

The number of bytes copied to destination.

Exceptions | Edit this page View Source ReadAsync(CancellationToken)

Fetches the data from the underlying storage to the internal buffer.

Declaration
public ValueTask<bool> ReadAsync(CancellationToken token = default)
Parameters Type Name Description CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<bool>

true if the data has been copied from the underlying storage to the internal buffer; false if no more data to read.

Exceptions | Edit this page View Source ReadAsync<T>(CancellationToken)

Decodes the value of binary formattable type.

Declaration
public ValueTask<T> ReadAsync<T>(CancellationToken token = default) where T : IBinaryFormattable<T>
Parameters Type Name Description CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<T>

The decoded value.

Type Parameters Name Description T

The type of the result.

Exceptions | Edit this page View Source ReadBigEndianAsync<T>(CancellationToken)

Reads integer encoded in big-endian format.

Declaration
public ValueTask<T> ReadBigEndianAsync<T>(CancellationToken token = default) where T : IBinaryInteger<T>
Parameters Type Name Description CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<T>

The integer value.

Type Parameters Name Description T

The integer type.

Exceptions | Edit this page View Source ReadLittleEndianAsync<T>(CancellationToken)

Reads integer encoded in little-endian format.

Declaration
public ValueTask<T> ReadLittleEndianAsync<T>(CancellationToken token = default) where T : IBinaryInteger<T>
Parameters Type Name Description CancellationToken token

The token that can be used to cancel the operation.

Returns Type Description ValueTask<T>

The integer value.

Type Parameters Name Description T

The integer type.

Exceptions | Edit this page View Source Reset()

Clears the read buffer.

Declaration | Edit this page View Source Skip(long)

Skips the specified number of bytes and advances file read cursor.

Declaration
public void Skip(long count)
Parameters Type Name Description long count

The number of bytes to skip.

Exceptions Implements Extension Methods

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