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

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

Class FileBufferingWriter | .NEXT

Represents builder of contiguous block of memory that may switch to file as its backing store.

FileBufferingWriter

public sealed class FileBufferingWriter : Stream, IAsyncDisposable, IBufferWriter<byte>, IGrowableBuffer<byte>, IReadOnlySpanConsumer<byte>, ISupplier<ReadOnlyMemory<byte>, CancellationToken, ValueTask>, IFunctional<Func<ReadOnlyMemory<byte>, CancellationToken, ValueTask>>, IDisposable, IResettable, IFlushable, IDynamicInterfaceCastable

Initializes a new writer.

public FileBufferingWriter(MemoryAllocator<byte>? allocator = null, int memoryThreshold = 32768, int initialCapacity = 0, string? tempDir = null, bool asyncIO = true)

The allocator of internal buffer.

The maximum amount of memory in bytes to allocate before switching to a file on disk.

Initial capacity of internal buffer. Should not be greater than memoryThreshold.

The location of the directory to write buffered contents to. When unspecified, uses the value specified by the environment variable ASPNETCORE_TEMP if available, otherwise uses the value returned by GetTempPath().

true if you will use asynchronous methods of the instance; otherwise, false.

Initializes a new writer.

public FileBufferingWriter(in FileBufferingWriter.Options options)

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

public override bool CanRead { get; }

true if the stream supports reading; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

public override bool CanSeek { get; }

true if the stream supports seeking; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

public override bool CanWrite { get; }

true if the stream supports writing; otherwise, false.

When overridden in a derived class, gets the length in bytes of the stream.

public override long Length { get; }

A long value representing the length of the stream in bytes.

When overridden in a derived class, gets or sets the position within the current stream.

public override long Position { get; set; }

The current position within the stream.

Notifies the IBufferWriter<T> that count data items were written to the output Span<T> or Memory<T>.

public void Advance(int count)

Begins an asynchronous read operation. (Consider using ReadAsync(byte[], int, int) instead.)

public override IAsyncResult BeginRead(byte[] data, int offset, int count, AsyncCallback? callback, object? state)

The byte offset in buffer at which to begin writing data read from the stream.

The maximum number of bytes to read.

An optional asynchronous callback, to be called when the read is complete.

A user-provided object that distinguishes this particular asynchronous read request from other requests.

Begins an asynchronous write operation. (Consider using WriteAsync(byte[], int, int) instead.)

public override IAsyncResult BeginWrite(byte[] data, int offset, int count, AsyncCallback? callback, object? state)

The byte offset in buffer from which to begin writing.

The maximum number of bytes to write.

An optional asynchronous callback, to be called when the write is complete.

A user-provided object that distinguishes this particular asynchronous write request from other requests.

An IAsyncResult that represents the asynchronous write, which could still be pending.

Removes all written data.

public void Clear(bool reuseBuffer = true)

true to keep internal buffer alive; otherwise, false.

Drains buffered content to the buffer synchronously.

public void CopyTo(IBufferWriter<byte> destination, int bufferSize = 1024, CancellationToken token = default)

The buffer to drain buffered contents to.

The size, in bytes, of the buffer used to copy bytes.

The token to monitor for cancellation requests.

Drains buffered content to the stream synchronously.

public override void CopyTo(Stream destination, int bufferSize)

The stream to drain buffered contents to.

The size, in bytes, of the buffer used to copy bytes.

Drains buffered content to the memory block synchronously.

public int CopyTo(Span<byte> output)

The memory block used as a destination for copy operation.

The actual number of copied elements.

Drains buffered content to the buffer asynchronously.

public Task CopyToAsync(IBufferWriter<byte> destination, int bufferSize = 1024, CancellationToken token = default)

The buffer to drain buffered contents to.

The size, in bytes, of the buffer used to copy bytes.

The token to monitor for cancellation requests.

The task representing asynchronous execution of this method.

Drains buffered content to the stream asynchronously.

public override Task CopyToAsync(Stream destination, int bufferSize, CancellationToken token)

The stream to drain buffered contents to.

The size, in bytes, of the buffer used to copy bytes.

The token to monitor for cancellation requests.

A task that represents the asynchronous copy operation.

Drains buffered content to the memory block asynchronously.

public ValueTask<int> CopyToAsync(Memory<byte> output, CancellationToken token = default)

The memory block used as a destination for copy operation.

The token that can be used to cancel the operation.

The actual number of copied elements.

Drains buffered content asynchronously.

public Task CopyToAsync<TArg>(ReadOnlySpanAction<byte, TArg> reader, TArg arg, int bufferSize = 1024, CancellationToken token = default)

The content reader.

The argument to be passed to the callback.

The size, in bytes, of the buffer used to copy bytes.

The token that can be used to cancel the operation.

The task representing asynchronous execution of the operation.

The type of the argument to be passed to the callback.

Drains the written content to the consumer asynchronously.

public Task CopyToAsync<TConsumer>(TConsumer consumer, int bufferSize, CancellationToken token) where TConsumer : ISupplier<ReadOnlyMemory<byte>, CancellationToken, ValueTask>

The consumer of the written content.

The size, in bytes, of the buffer used to copy bytes.

The token that can be used to cancel the operation.

The task representing asynchronous execution of this method.

The type of the consumer.

Drains buffered content synchronously.

public void CopyTo<TArg>(ReadOnlySpanAction<byte, TArg> reader, TArg arg, int bufferSize = 1024, CancellationToken token = default)

The content reader.

The argument to be passed to the callback.

The size, in bytes, of the buffer used to copy bytes.

The token that can be used to cancel the operation.

The type of the argument to be passed to the callback.

Drains the written content to the consumer synchronously.

public void CopyTo<TConsumer>(TConsumer consumer, int bufferSize, CancellationToken token) where TConsumer : IReadOnlySpanConsumer<byte>

The consumer of the written content.

The size, in bytes, of the buffer used to copy bytes.

The token that can be used to cancel the operation.

The type of the consumer.

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

protected override void Dispose(bool disposing)

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Waits for the pending asynchronous read to complete. (Consider using ReadAsync(byte[], int, int) instead.)

public override int EndRead(IAsyncResult asyncResult)

The reference to the pending asynchronous request to finish.

The number of bytes read from the stream, between zero (0) and the number of bytes requested. ReadAsync returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).

Ends an asynchronous write operation. (Consider using WriteAsync(byte[], int, int) instead.)

public override void EndWrite(IAsyncResult ar)

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

public override void Flush()

Flushes the internal buffer with the file and optionally synchronize a file's in-core state with storage device.

public void Flush(bool flushToDisk)

true to synchronize a file's in-core state with storage device; otherwise, false.

Flushes the internal buffer with the file and optionally synchronize a file's in-core state with storage device.

public ValueTask FlushAsync(bool flushToDisk, CancellationToken token = default)

true to synchronize a file's in-core state with storage device; otherwise, false.

The token that can be used to cancel the operation.

The asynchronous result of the operation.

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

public override Task FlushAsync(CancellationToken token)

A task that represents the asynchronous flush operation.

Returns a Memory<T> to write to that is at least the requested size (specified by sizeHint).

public Memory<byte> GetMemory(int sizeHint = 0)

The minimum length of the returned Memory<T>. If 0, a non-empty buffer is returned.

A Memory<T> of at least the size sizeHint. If sizeHint is 0, returns a non-empty buffer.

Returns a Span<T> to write to that is at least the requested size (specified by sizeHint).

public Span<byte> GetSpan(int sizeHint = 0)

The minimum length of the returned Span<T>. If 0, a non-empty buffer is returned.

A Span<T> of at least the size sizeHint. If sizeHint is 0, returns a non-empty buffer.

Returns the whole buffered content as a source of Memory<T> instances synchronously.

public IMemoryOwner<byte> GetWrittenContent()

The memory manager providing access to buffered content.

Gets written content in the form of ReadOnlySequence<T> synchronously.

public IReadOnlySequenceSource<byte> GetWrittenContent(int segmentSize)

The size of the contiguous segment of file to be mapped to memory.

Returns buffered content as a source of Memory<T> instances synchronously.

public IMemoryOwner<byte> GetWrittenContent(Range range)

The range of buffered content to return.

The memory manager providing access to buffered content.

Gets written content as read-only stream.

public Stream GetWrittenContentAsStream()

Read-only stream representing the written content.

Gets written content as read-only stream asynchronously.

public ValueTask<Stream> GetWrittenContentAsStreamAsync(CancellationToken token = default)

The token that can be used to cancel the operation.

Read-only stream representing the written content.

Returns buffered content as a source of Memory<T> instances asynchronously.

public ValueTask<IMemoryOwner<byte>> GetWrittenContentAsync(Range range, CancellationToken token = default)

The range of buffered content to return.

The token that can be used to cancel the operation.

Returns the whole buffered content as a source of Memory<T> instances asynchronously.

public ValueTask<IMemoryOwner<byte>> GetWrittenContentAsync(CancellationToken token = default)

The token that can be used to cancel the operation.

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.

public override int Read(byte[] data, int offset, int count)

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

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 count is 0 or the end of the stream has been reached.

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.

public override int Read(Span<byte> data)

The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached.

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.

public override Task<int> ReadAsync(byte[] data, int offset, int count, CancellationToken token)

The byte offset in buffer at which to begin writing data from the stream.

The maximum number of bytes to read.

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached.

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.

public override ValueTask<int> ReadAsync(Memory<byte> data, CancellationToken token = default)

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 length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.

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 int, or -1 if at the end of the stream.

When overridden in a derived class, sets the position within the current stream.

public override long Seek(long offset, SeekOrigin origin)

A byte offset relative to the origin parameter.

A value of type SeekOrigin indicating the reference point used to obtain the new position.

The new position within the current stream.

When overridden in a derived class, sets the length of the current stream.

public override void SetLength(long value)

The desired length of the current stream in bytes.

Attempts to get written content if it is located in memory.

public bool TryGetWrittenContent(out ReadOnlyMemory<byte> content)

Attempts to get written content if it is located in memory.

public bool TryGetWrittenContent(out ReadOnlyMemory<byte> content, out string? fileName)

The written content.

The path to the file used as a buffer if this writer switched to the file.

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.

public override void Write(byte[] data, int offset, int count)

The zero-based byte offset in buffer at which to begin copying bytes to the current stream.

The number of bytes to be written to the current stream.

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.

public override void Write(ReadOnlySpan<byte> input)

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.

public override Task WriteAsync(byte[] data, int offset, int count, CancellationToken token)

The zero-based byte offset in buffer from which to begin copying bytes to the stream.

The maximum number of bytes to write.

A task that represents the asynchronous write operation.

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.

public override ValueTask WriteAsync(ReadOnlyMemory<byte> input, CancellationToken token = default)

A task that represents the asynchronous write operation.

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)

The byte to write to the stream.

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