Stream Classe

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Origem:

Stream.cs

Fornece uma exibição genérica de uma sequência de bytes. Esta é uma classe abstrata.

public ref class Stream abstract : MarshalByRefObject, IAsyncDisposable, IDisposable

public abstract class Stream : MarshalByRefObject, IAsyncDisposable, IDisposable

type Stream = class
    inherit MarshalByRefObject
    interface IAsyncDisposable
    interface IDisposable

Public MustInherit Class Stream
Inherits MarshalByRefObject
Implements IAsyncDisposable, IDisposable

Herança

Object

MarshalByRefObject

Stream

Derivado

Microsoft.JScript.COMCharStream

System.Data.OracleClient.OracleBFile

System.Data.OracleClient.OracleLob

System.Data.SqlTypes.SqlFileStream

System.IO.BufferedStream

System.IO.Compression.BrotliStream

System.IO.Compression.DeflateStream

System.IO.Compression.GZipStream

System.IO.Compression.ZLibStream

System.IO.FileStream

System.IO.MemoryStream

System.IO.Pipes.PipeStream

System.IO.UnmanagedMemoryStream

System.Net.Quic.QuicStream

System.Net.Security.AuthenticatedStream

System.Net.Sockets.NetworkStream

System.Printing.PrintQueueStream

System.Security.Cryptography.CryptoStream

Implementações

IDisposable IAsyncDisposable

Exemplos

O exemplo a seguir demonstra como usar dois objetos FileStream para copiar de forma assíncrona os arquivos de um diretório para outro diretório. A classe FileStream deriva da classe Stream. Observe que o manipulador de eventos Click para o controle Button está marcado com o modificador async porque ele chama um método assíncrono.

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

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

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string StartDirectory = @"c:\Users\exampleuser\start";
            string EndDirectory = @"c:\Users\exampleuser\end";

            foreach (string filename in Directory.EnumerateFiles(StartDirectory))
            {
                using (FileStream SourceStream = File.Open(filename, FileMode.Open))
                {
                    using (FileStream DestinationStream = File.Create(EndDirectory + filename.Substring(filename.LastIndexOf('\\'))))
                    {
                        await SourceStream.CopyToAsync(DestinationStream);
                    }
                }
            }
        }
    }
}

Imports System.IO

Class MainWindow

    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim StartDirectory As String = "c:\Users\exampleuser\start"
        Dim EndDirectory As String = "c:\Users\exampleuser\end"

        For Each filename As String In Directory.EnumerateFiles(StartDirectory)
            Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
                Using DestinationStream As FileStream = File.Create(EndDirectory + filename.Substring(filename.LastIndexOf("\"c)))
                    Await SourceStream.CopyToAsync(DestinationStream)
                End Using

            End Using
        Next
    End Sub

End Class

Comentários

Stream é a classe base abstrata de todos os fluxos. Um fluxo é uma abstração de uma sequência de bytes, como um arquivo, um dispositivo de entrada/saída, um pipe de comunicação entre processos ou um soquete TCP/IP. A classe Stream e suas classes derivadas fornecem uma exibição genérica desses diferentes tipos de entrada e saída e isolam o programador dos detalhes específicos do sistema operacional e dos dispositivos subjacentes.

Os fluxos envolvem três operações fundamentais:

• Você pode ler de fluxos. A leitura é a transferência de dados de um fluxo para uma estrutura de dados, como uma matriz de bytes.

• Você pode gravar em fluxos. Gravar é a transferência de dados de uma estrutura de dados para um fluxo.

• Os fluxos podem dar suporte à busca. A busca refere-se à consulta e à modificação da posição atual em um fluxo. A funcionalidade seek depende do tipo de repositório de backup que um fluxo tem. Por exemplo, os fluxos de rede não têm nenhum conceito unificado de uma posição atual e, portanto, normalmente não dão suporte à busca.

Alguns dos fluxos mais usados que herdam de Stream são FileStreame MemoryStream.

Dependendo da fonte de dados ou repositório subjacente, os fluxos podem dar suporte apenas a alguns desses recursos. Você pode consultar um fluxo para seus recursos usando as propriedades CanRead, CanWritee CanSeek da classe Stream.

Os métodos Read e Write leem e gravam dados em uma variedade de formatos. Para fluxos que dão suporte à busca, use os métodos Seek e SetLength e as propriedades Position e Length para consultar e modificar a posição e o comprimento atuais de um fluxo.

Esse tipo implementa a interface IDisposable. Quando terminar de usar o tipo, você deverá descartá-lo direta ou indiretamente. Para descartar o tipo diretamente, chame seu método Dispose em um bloco de try/catch. Para descartá-lo indiretamente, use um constructo de linguagem como using (em C#) ou Using (no Visual Basic). Para obter mais informações, consulte a seção "Usando um objeto que implementa idisposable" no tópico da interface IDisposable.

Descartar um objeto Stream libera todos os dados em buffer e, essencialmente, chama o método Flush para você. Dispose também libera recursos do sistema operacional, como identificadores de arquivo, conexões de rede ou memória usadas para qualquer buffer interno. A classe BufferedStream fornece a capacidade de encapsular um fluxo em buffer em torno de outro fluxo, a fim de melhorar o desempenho de leitura e gravação.

A partir do .NET Framework 4.5, a classe Stream inclui métodos assíncronos para simplificar operações assíncronas. Um método assíncrono contém Async em seu nome, como ReadAsync, WriteAsync, CopyToAsynce FlushAsync. Esses métodos permitem que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread principal. Essa consideração de desempenho é particularmente importante em um aplicativo da Windows 8.x Store ou aplicativo da área de trabalho em que uma operação de fluxo demorada pode bloquear o thread da interface do usuário e fazer seu aplicativo aparecer como se ele não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as palavras-chave async e await no Visual Basic e no C#.

Quando usado em um aplicativo da Windows 8.x Store, Stream inclui dois métodos de extensão: AsInputStream e AsOutputStream. Esses métodos convertem um objeto Stream em um fluxo no Windows Runtime. Você também pode converter um fluxo no Windows Runtime em um objeto Stream usando os métodos AsStreamForRead e AsStreamForWrite. Para obter mais informações, consulte Como converter entre fluxos do .NET Framework e fluxos do Windows Runtime

Algumas implementações de fluxo executam o buffer local dos dados subjacentes para melhorar o desempenho. Para esses fluxos, você pode usar o método Flush ou FlushAsync para limpar os buffers internos e garantir que todos os dados foram gravados na fonte de dados ou repositório subjacente.

Se você precisar de um fluxo sem repositório de backup (também conhecido como bucket de bits), use o campo Null para recuperar uma instância de um fluxo projetado para essa finalidade.

Notas aos Implementadores

Ao implementar uma classe derivada de Stream, você deve fornecer implementações para os métodos Read(Byte[], Int32, Int32) e Write(Byte[], Int32, Int32). Os métodos assíncronos ReadAsync(Byte[], Int32, Int32), WriteAsync(Byte[], Int32, Int32)e CopyToAsync(Stream) usam os métodos síncronos Read(Byte[], Int32, Int32) e Write(Byte[], Int32, Int32) em suas implementações. Portanto, suas implementações de Read(Byte[], Int32, Int32) e Write(Byte[], Int32, Int32) funcionarão corretamente com os métodos assíncronos. As implementações padrão de ReadByte() e WriteByte(Byte) criar uma nova matriz de bytes de elemento único e, em seguida, chamar suas implementações de Read(Byte[], Int32, Int32) e Write(Byte[], Int32, Int32). Quando você deriva de Stream, recomendamos que você substitua esses métodos para acessar seu buffer interno, se você tiver um, para um desempenho substancialmente melhor. Você também deve fornecer implementações de CanRead, CanSeek, CanWrite, Flush(), Length, Position, Seek(Int64, SeekOrigin)e SetLength(Int64).

Não substitua o método Close(), em vez disso, coloque toda a lógica de limpeza Stream no método Dispose(Boolean). Para obter mais informações, consulte Implementando um método de descarte.

Construtores

Stream()

Inicializa uma nova instância da classe Stream.

Campos

Null	Um Stream sem repositório de backup.

Propriedades

CanRead	Quando substituído em uma classe derivada, obtém um valor que indica se o fluxo atual dá suporte à leitura.
CanSeek	Quando substituído em uma classe derivada, obtém um valor que indica se o fluxo atual dá suporte à busca.
CanTimeout	Obtém um valor que determina se o fluxo atual pode acabar.
CanWrite	Quando substituído em uma classe derivada, obtém um valor que indica se o fluxo atual dá suporte à gravação.
Length	Quando substituído em uma classe derivada, obtém o comprimento em bytes do fluxo.
Position	Quando substituído em uma classe derivada, obtém ou define a posição dentro do fluxo atual.
ReadTimeout	Obtém ou define um valor, em milissegundos, que determina quanto tempo o fluxo tentará ler antes do tempo limite.
WriteTimeout	Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará gravar antes do tempo limite.

Métodos

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Inicia uma operação de leitura assíncrona. (Considere usar ReadAsync(Byte[], Int32, Int32) em vez disso.)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Inicia uma operação de gravação assíncrona. (Considere usar WriteAsync(Byte[], Int32, Int32) em vez disso.)
Close()	Fecha o fluxo atual e libera todos os recursos (como soquetes e identificadores de arquivo) associados ao fluxo atual. Em vez de chamar esse método, verifique se o fluxo foi descartado corretamente.
CopyTo(Stream)	Lê os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxos são avançadas pelo número de bytes copiados.
CopyTo(Stream, Int32)	Lê os bytes do fluxo atual e os grava em outro fluxo, usando um tamanho de buffer especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados.
CopyToAsync(Stream)	Lê assíncronamente os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxos são avançadas pelo número de bytes copiados.
CopyToAsync(Stream, CancellationToken)	Lê assíncronamente os bytes do fluxo atual e os grava em outro fluxo, usando um token de cancelamento especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados.
CopyToAsync(Stream, Int32)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo, usando um tamanho de buffer especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados.
CopyToAsync(Stream, Int32, CancellationToken)	Lê assíncronamente os bytes do fluxo atual e os grava em outro fluxo, usando um token de cancelamento e tamanho de buffer especificado. Ambas as posições de fluxos são avançadas pelo número de bytes copiados.
CreateObjRef(Type)	Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto. (Herdado de MarshalByRefObject)
CreateWaitHandle()	Obsoleto. Aloca um objeto WaitHandle.
Dispose()	Libera todos os recursos usados pelo Stream.
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo Stream e, opcionalmente, libera os recursos gerenciados.
DisposeAsync()	Libera de forma assíncrona os recursos não gerenciados usados pelo Stream.
EndRead(IAsyncResult)	Aguarda a conclusão da leitura assíncrona pendente. (Considere usar ReadAsync(Byte[], Int32, Int32) em vez disso.)
EndWrite(IAsyncResult)	Encerra uma operação de gravação assíncrona. (Considere usar WriteAsync(Byte[], Int32, Int32) em vez disso.)
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Flush()	Quando substituído em uma classe derivada, limpa todos os buffers para esse fluxo e faz com que todos os dados em buffer sejam gravados no dispositivo subjacente.
FlushAsync()	Limpa de forma assíncrona todos os buffers para esse fluxo e faz com que todos os dados em buffer sejam gravados no dispositivo subjacente.
FlushAsync(CancellationToken)	Limpa de forma assíncrona todos os buffers para esse fluxo, faz com que todos os dados em buffer sejam gravados no dispositivo subjacente e monitora solicitações de cancelamento.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetLifetimeService()	Obsoleto. Recupera o objeto de serviço de tempo de vida atual que controla a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeLifetimeService()	Obsoleto. Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida dessa instância. (Herdado de MarshalByRefObject)
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
ObjectInvariant()	Obsoleto. Fornece suporte para um Contract.
Read(Byte[], Int32, Int32)	Quando substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos.
Read(Span<Byte>)	Quando substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos.
ReadAsync(Byte[], Int32, Int32)	Lê de forma assíncrona uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento.
ReadAsync(Memory<Byte>, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Lê pelo menos um número mínimo de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos.
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Lê de forma assíncrona pelo menos um número mínimo de bytes do fluxo atual, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento.
ReadByte()	Lê um byte do fluxo e avança a posição dentro do fluxo por um byte ou retorna -1 se estiver no final do fluxo.
ReadExactly(Byte[], Int32, Int32)	Lê count número de bytes do fluxo atual e avança a posição dentro do fluxo.
ReadExactly(Span<Byte>)	Lê bytes do fluxo atual e avança a posição dentro do fluxo até que a buffer seja preenchida.
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Lê de forma assíncrona count número de bytes do fluxo atual, avança a posição dentro do fluxo e monitora solicitações de cancelamento.
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Lê bytes de forma assíncrona do fluxo atual, avança a posição dentro do fluxo até que o buffer seja preenchido e monitore as solicitações de cancelamento.
Seek(Int64, SeekOrigin)	Quando substituído em uma classe derivada, define a posição dentro do fluxo atual.
SetLength(Int64)	Quando substituído em uma classe derivada, define o comprimento do fluxo atual.
Synchronized(Stream)	Cria um wrapper thread-safe (sincronizado) ao redor do objeto Stream especificado.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
ValidateBufferArguments(Byte[], Int32, Int32)	Valida argumentos fornecidos para ler e escrever métodos em Stream.
ValidateCopyToArguments(Stream, Int32)	Valida os argumentos fornecidos aos métodos CopyTo(Stream, Int32) ou CopyToAsync(Stream, Int32, CancellationToken).
Write(Byte[], Int32, Int32)	Quando substituído em uma classe derivada, grava uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes gravados.
Write(ReadOnlySpan<Byte>)	Quando substituído em uma classe derivada, grava uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes gravados.
WriteAsync(Byte[], Int32, Int32)	Grava de forma assíncrona uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo pelo número de bytes gravados.
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Grava de forma assíncrona uma sequência de bytes no fluxo atual, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora solicitações de cancelamento.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Grava de forma assíncrona uma sequência de bytes no fluxo atual, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora solicitações de cancelamento.
WriteByte(Byte)	Grava um byte na posição atual no fluxo e avança a posição dentro do fluxo por um byte.

Métodos de Extensão

CopyToAsync(Stream, PipeWriter, CancellationToken)	Lê assíncronamente os bytes do Stream e os grava no PipeWriterespecificado usando um token de cancelamento.
ConfigureAwait(IAsyncDisposable, Boolean)	Configura como as esperas nas tarefas retornadas de um descartável assíncrono serão executadas.

Confira também

• FileStream
• MemoryStream
• BufferedStream
• de E/S de Fluxo e Arquivo
• Como converter entre fluxos do .NET Framework e fluxos do Windows Runtime