Stream Classe

Definição

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

public ref class Stream abstract : IDisposable
public ref class Stream abstract : MarshalByRefObject, IAsyncDisposable, IDisposable
public ref class Stream abstract : MarshalByRefObject, IDisposable
public abstract class Stream : IDisposable
public abstract class Stream : MarshalByRefObject, IAsyncDisposable, IDisposable
public abstract class Stream : MarshalByRefObject, IDisposable
[System.Serializable]
public abstract class Stream : MarshalByRefObject, IDisposable
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class Stream : MarshalByRefObject, IDisposable
type Stream = class
    interface IDisposable
type Stream = class
    inherit MarshalByRefObject
    interface IAsyncDisposable
    interface IDisposable
type Stream = class
    inherit MarshalByRefObject
    interface IDisposable
[<System.Serializable>]
type Stream = class
    inherit MarshalByRefObject
    interface IDisposable
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type Stream = class
    inherit MarshalByRefObject
    interface IDisposable
Public MustInherit Class Stream
Implements IDisposable
Public MustInherit Class Stream
Inherits MarshalByRefObject
Implements IAsyncDisposable, IDisposable
Public MustInherit Class Stream
Inherits MarshalByRefObject
Implements IDisposable
Herança
Stream
Herança
Derivado
Atributos
Implementações

Exemplos

O exemplo a seguir demonstra como usar dois FileStream objetos para copiar de forma assíncrona os arquivos de um diretório para outro diretório. A FileStream classe deriva da Stream classe. Observe que o manipulador de eventos Click para o controle Button está marcado com o modificador async, pois 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 arquivos entrada/saída, um pipe de comunicação de inter- processo, ou um soquete TCP/IP. A Stream classe 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.

Fluxos envolvem estas 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. A gravação é a transferência de dados de uma estrutura de dados para um fluxo.

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

Alguns dos fluxos mais comumente usados que herdam de Stream são FileStream , e MemoryStream .

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

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

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

Descartar um Stream objeto libera todos os dados armazenados em buffer e, essencialmente, chama o Flush método para você. Dispose o também libera recursos do sistema operacional, como identificadores de arquivos, conexões de rede ou memória usada para qualquer buffer interno. A BufferedStream classe 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 Stream classe 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 CopyToAsync e 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 de armazenamento Windows 8. x ou aplicativo de área de trabalho em que uma operação de fluxo demorado pode bloquear o thread da interface do usuário e fazer seu aplicativo aparecer como se ele não estiver funcionando. os métodos assíncronos são usados em conjunto com async as await palavras-chave e em Visual Basic e C#.

quando usado em um aplicativo da loja Windows 8. x, o Stream inclui dois métodos de extensão: AsInputStream e AsOutputStream . esses métodos convertem um Stream objeto em um fluxo no Windows Runtime. você também pode converter um fluxo no Windows Runtime em um Stream objeto usando os AsStreamForRead AsStreamForWrite métodos e. para obter mais informações, consulte como converter entre .NET Framework Fluxos e Windows Runtime Fluxos

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

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

Notas aos Implementadores

Ao implementar uma classe derivada do Stream , você deve fornecer implementações para os Read(Byte[], Int32, Int32) Write(Byte[], Int32, Int32) métodos e. 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 do Read(Byte[], Int32, Int32) e do Write(Byte[], Int32, Int32) funcionarão corretamente com os métodos assíncronos. As implementações padrão de ReadByte() e WriteByte(Byte) criam uma nova matriz de bytes de elemento único e, em seguida, chamam 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 do,,,,,, CanRead CanSeek CanWrite Flush() Length Position Seek(Int64, SeekOrigin) e SetLength(Int64) .

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

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 atingir o tempo limite.

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 tamanho 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 por quanto tempo o fluxo tentará realizar a leitura antes do tempo limite.

WriteTimeout

Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará realizar a gravação antes do tempo limite.

Métodos

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Inicia uma operação de leitura assíncrona. (Considere o uso de ReadAsync(Byte[], Int32, Int32) em seu lugar.)

BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Inicia uma operação de gravação assíncrona. (Considere o uso de WriteAsync(Byte[], Int32, Int32) em seu lugar.)

Close()

Fecha o fluxo atual e libera todos os recursos (como soquetes e identificadores de arquivos) associados ao fluxo atual. Em vez de chamar esse método, verifique se o fluxo é descartado corretamente.

CopyTo(Stream)

Lê os bytes do fluxo atual e os grava em outro fluxo.

CopyTo(Stream, Int32)

Lê os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado.

CopyToAsync(Stream)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo.

CopyToAsync(Stream, CancellationToken)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um token de cancelamento especificado.

CopyToAsync(Stream, Int32)

Lê de maneira assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado.

CopyToAsync(Stream, Int32, CancellationToken)

Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado e um token de cancelamento.

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.
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)

Espera a leitura assíncrona pendente ser concluída. (Considere o uso de ReadAsync(Byte[], Int32, Int32) em seu lugar.)

EndWrite(IAsyncResult)

Encerra uma operação de gravação assíncrona. (Considere o uso de WriteAsync(Byte[], Int32, Int32) em seu lugar.)

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 nesse fluxo e faz com que todos os dados armazenados em buffer sejam gravados no dispositivo subjacente.

FlushAsync()

Limpa de forma assíncrona todos os buffers nesse fluxo e faz com que os dados armazenados em buffer sejam gravados no dispositivo subjacente.

FlushAsync(CancellationToken)

Limpa todos os buffers nesse fluxo de forma assíncrona, faz com que os dados armazenados em buffer sejam gravados no dispositivo subjacente e monitora as 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 ciclo de vida para esta 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 para essa instância.

(Herdado de MarshalByRefObject)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto MarshalByRefObject atual.

(Herdado de MarshalByRefObject)
ObjectInvariant()
Obsoleto.

Oferece suporte a um Contract.

Read(Byte[], Int32, Int32)

Quando for substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo até o número de bytes lidos.

Read(Span<Byte>)

Quando for substituído em uma classe derivada, lê uma sequência de bytes do fluxo atual e avança a posição dentro do fluxo até o número de bytes lidos.

ReadAsync(Byte[], Int32, Int32)

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o 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 no fluxo até o número de bytes lidos e monitora as 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 no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.

ReadByte()

Lê um byte do fluxo e avança a posição no fluxo em um byte ou retorna -1 caso esteja no final do fluxo.

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 tamanho do fluxo atual.

Synchronized(Stream)

Cria um wrapper thread-safe (sincronizado) em torno do objeto Stream especificado.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)
ValidateBufferArguments(Byte[], Int32, Int32)

Valida os argumentos fornecidos para ler e escrever métodos em Stream .

ValidateCopyToArguments(Stream, Int32)

Valida os argumentos fornecidos para os CopyTo(Stream, Int32) CopyToAsync(Stream, Int32, CancellationToken) métodos ou .

Write(Byte[], Int32, Int32)

Quando for 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 até o número de bytes gravados.

Write(ReadOnlySpan<Byte>)

Quando for 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 até o número de bytes gravados.

WriteAsync(Byte[], Int32, Int32)

Grava assincronamente uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo no número de bytes gravados.

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

Grava uma sequência de bytes no fluxo atual assincronamente, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora as solicitações de cancelamento.

WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)

Grava uma sequência de bytes no fluxo atual assincronamente, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora as solicitações de cancelamento.

WriteByte(Byte)

Grava um byte na posição atual no fluxo e avança a posição dentro no fluxo em um byte.

Implantações explícitas de interface

IDisposable.Dispose()

Libera todos os recursos usados pelo Stream.

Métodos de Extensão

AsInputStream(Stream)

Converte um fluxo gerenciado no .NET para Aplicativos da Windows Store em um fluxo de entrada no Windows Runtime.

AsOutputStream(Stream)

Converte um fluxo gerenciado no .NET para Aplicativos da Windows Store em um fluxo de saída no Windows Runtime.

AsRandomAccessStream(Stream)

Converte o fluxo especificado em um fluxo de acesso aleatório.

ConfigureAwait(IAsyncDisposable, Boolean)

Configura como as esperas nas tarefas retornadas de um descartável assíncrono são realizadas.

Aplica-se a

Confira também