FileStream.ReadAsync Método

Definição

Namespace:

System.IO

Assemblies:

netstandard.dll, System.Runtime.dll

Sobrecargas

Nome	Description
ReadAsync(Memory<Byte>, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo de arquivos atual e os grava em uma região de memória, avança a posição dentro do fluxo de arquivos pelo número de bytes lidos e monitora solicitações de cancelamento.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo de arquivos atual e os grava em uma matriz de bytes começando em um deslocamento especificado, avança a posição dentro do fluxo de arquivos pelo número de bytes lidos e monitora solicitações de cancelamento.

ReadAsync(Memory<Byte>, CancellationToken)

Origem:

FileStream.cs

Lê de forma assíncrona uma sequência de bytes do fluxo de arquivos atual e os grava em uma região de memória, avança a posição dentro do fluxo de arquivos pelo número de bytes lidos e monitora solicitações de cancelamento.

public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parâmetros

buffer

Memory<Byte>

O buffer no qual gravar os dados.

cancellationToken

CancellationToken

O token a ser monitorado para solicitações de cancelamento. O valor padrão é None.

Retornos

ValueTask<Int32>

Uma tarefa que representa a operação de leitura assíncrona e encapsula o número total de bytes lidos no buffer. O valor do resultado pode ser menor do que o número de bytes solicitados se o número de bytes atualmente disponível for menor que o número solicitado ou pode ser 0 (zero) se o final do fluxo tiver sido atingido.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Exemplos

O exemplo a seguir mostra como ler de um arquivo de forma assíncrona.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Comentários

O ReadAsync método permite que você execute operações de arquivo com uso intensivo de recursos sem bloquear o thread principal. Essa consideração sobre o desempenho é particularmente importante em um aplicativo da Microsoft Store 8.x ou aplicativo de desktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e await em Visual Basic e C#.

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Status propriedade. Se o identificador para o arquivo for descartado, a tarefa retornada conterá a ObjectDisposedException exceção na Task.Exception propriedade.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Origem:

FileStream.cs

Lê de forma assíncrona uma sequência de bytes do fluxo de arquivos atual e os grava em uma matriz de bytes começando em um deslocamento especificado, avança a posição dentro do fluxo de arquivos pelo número de bytes lidos e monitora solicitações de cancelamento.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parâmetros

buffer

Byte[]

O buffer no qual gravar os dados.

offset

Int32

O deslocamento de bytes no buffer qual começar a gravar dados do fluxo.

count

Int32

O número máximo de bytes a serem lidos.

cancellationToken

CancellationToken

O token a ser monitorado para solicitações de cancelamento.

Retornos

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona e encapsula o número total de bytes lidos no buffer. O valor do resultado pode ser menor do que o número de bytes solicitados se o número de bytes atualmente disponível for menor que o número solicitado ou pode ser 0 (zero) se o final do fluxo tiver sido atingido.

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset ou count é negativo.

ArgumentException

A soma de offset e count é maior que o comprimento do buffer.

NotSupportedException

O fluxo não dá suporte à leitura.

ObjectDisposedException

O fluxo foi descartado.

InvalidOperationException

No momento, o fluxo está em uso por uma operação de leitura anterior.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Exemplos

O exemplo a seguir mostra como ler de um arquivo de forma assíncrona.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Comentários

O ReadAsync método permite que você execute operações de arquivo com uso intensivo de recursos sem bloquear o thread principal. Essa consideração sobre o desempenho é particularmente importante em um aplicativo da Microsoft Store 8.x ou aplicativo de desktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e await em Visual Basic e C#.

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Task.Status propriedade. Se o identificador para o arquivo for descartado, a tarefa retornada conterá a ObjectDisposedException exceção na Task.Exception propriedade.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Read(Byte[], Int32, Int32).

Confira também

• Cancelamento