Propriedade

Tipo

Descrição

size

Integer

Contém o tamanho atual do stream em quantidade de bytes.

position

Integer

A posição do cursor do stream.

onde o valor 0 representa o primeiro byte do stream.

Todas as operações de leitura e escrita são feitas nesta posição.

remainingBytes

Integer

Quantos bytes ainda podem ser lidos no stream à partir da posição atual.

md5

String

Uma cadeia de caracteres contendo o Hash MD5 de todo o conteúdo do stream. O Hash é calculado na hora de obter o valor da propriedade.

sha1

String

Uma cadeia de caracteres contendo o Hash SHA1 de todo o conteúdo do stream. O Hash é calculado na hora de obter o valor da propriedade.

Método

Descrição

stream:read(destArray, qtBytes)

Efetua a leitura de bytes à partir da position atual do stream. 

Parâmetros:

• destArray - Uma tabela lua que receberá os bytes lidos do stream. Os valores são armazenados em índices de 1 a N, onde N = quantidade de bytes lidos.
• qtBytes - Um número contendo a quantidade de bytes que devem ser lidos à partir desta posição.

Retorno:

• Um número contendo quantos bytes realmente foram lidos do stream e preenchidos em destArray

Importante:

• A position do stream é avançada automaticamente após a chamada desta função conforme a quantidade de bytes lidos.
• Nem sempre é possível ler a quantidade de bytes informada no parâmetro qtBytes. Você DEVE analisar o número retornado pela função a fim de saber quantos bytes realmente foram lidos.

stream:write(sourceArray [, qtBytes])

Efetua a escrita de bytes na position atual do stream.

Parâmetros:

• sourceArray - Uma tabela lua que contém os bytes que devem ser escritos no stream. Os valores devem estar armazenados em índices de 1 a N, onde N = quantidade de bytes que serão escritos.
• (OPCIONAL) qtBytes - Quantos bytes do sourceArray devem ser escritos no stream. Se omitido, o length do array (#sourceArray) será usado.

Retorno:

• Um número contendo quantos bytes realmente foram escritos no stream.

Importante:

• A position do stream é avançada automaticamente após a chamada desta função conforme a quantidade de bytes escritos.
• Os valores em sourceArray devem ser números! Para cada valor em sourceArray, se for menor que 0, o byte 0 será gravado e se for maior que 255, o byte 255 será gravado. Se em algum dos índices de sourceArray não contiver um número válido, o byte 0 é escrito no stream.

stream:close()

Fecha o stream imediatamente e libera os recursos que foram previamente alocados.

Após esta chamada, nenhuma operação do stream estará mais disponível.

stream:writeBinary(format, valor1 [, valor2 [, valor3 [, valorN...]]])

Escreve um valor codificado em binário na posição atual do stream.

Parâmetros:

• format - Cadeia de caracteres identificando qual formatação binária deve ser usada. Veja Formatos Binários para saber quais são os possíveis formatos.
• valor1 - O valor a ser codificado e escrito
• (OPCIONAL) valor2, valor3, valorN, etc... - Outros valores que também devem ser codificados e escritos no stream.

Retorno:

• Um número contendo quantos bytes foram escritos no stream.

Importante:

• A position do stream é avançada automaticamente após a chamada desta função conforme a quantidade de bytes escritos.

stream:readBinary(format [, qt])

Efetua a leitura de valores codificados em binário na posição atual do stream.

Parâmetros:

• format - Cadeia de caracteres identificando em qual formatação binária o valor está codificado. Veja Formatos Binários para saber quais são os possíveis formatos.
• (OPCIONAL) qt - Um número identificando QUANTOS valores codificados devem ser lidos. Se omitido, o valor 1 será utilizado.

Retorno:

• Retorna os valores decodificados ou nil se não foi possível decodificar.

Importante:

• A position do stream é avançada automaticamente após a chamada desta função conforme a quantidade de bytes lidos
• Se especificado os formatos "ansi', "utf8" ou "utf16", todo o restando do stream é lido como uma cadeia de caracteres e o parâmetro "qt" é ignorado como se o valor 1 tivesse sido passado para ele.

stream:readAsBase64([qtBytes])

Lê bytes do stream e retorna uma cadeia de caracteres representando os dados codificados em Base64.

Parâmetros:

• (OPCIONAL) qtBytes - Um número definindo quantos bytes do stream devem ser lidos à partir da posição atual e codificados. Se omitido, o restante dos dados do stream será lido.

Retorno:

• Uma cadeia de caracteres representando os dados codificados em Base64

stream:writeBase64(str)

Decodifica dados previamente codificados em Base64 e os escreve na posição atual do stream.

Parâmetros:

• str - Uma cadeia de caracteres contendo os dados codificados em Base64.

Retorno:

• Um número contendo quantos bytes foram escritos no Stream.

stream:copyFrom(stream, qtBytes)

Copia o conteúdo de um outro objeto stream dentro deste stream.

Parâmetros:

• stream - um objeto stream de onde os dados serão copiados.
• qtBytes - um número representando quantos bytes serão copiados à partir da posição atual do parâmetro "stream".

Retorno:

• Um número contendo quantos bytes realmente foram copiados para este stream.