FileStream  - AS3

Returnerar antalet databyte som kan läsas i indatabufferten. Användarens kod måste anropa bytesAvailable för att säkerställa att det finns tillräckligt mycket data innan det görs något läsförsök med andra läsmetoder.

Byteordning för data, antingen konstanten BIG_ENDIAN eller LITTLE_ENDIAN från klassen Endian.

Anger om AMF3- eller AMF0-formatet ska användas vid skrivning eller läsning av binära data med metoden readObject() eller writeObject().

Det här värdet är en konstant från ObjectEncoding-klassen. AMF3-formatet används som standard.

Relaterade API-element

Den aktuella positionen i filen.

Det här värdet kan ändras på något av följande sätt:

• När du anger egenskapen explicit
• Vid läsning från FileStream-objektet (med någon av read-metoderna).
• Vid skrivning till FileStream-objektet

Positionen definieras som ett nummer (i stället för en enhet) för att ha stöd för filer som är större än 2³² byte i längd. Värdet på den här egenskapen är alltid ett heltal som är mindre än 2⁵³. Om du anger det här värdet till ett tal med decimaler avrundas det nedåt till närmaste heltal.

När en fil läses asynkront, och du anger egenskapen position, börjar programmet att fylla läsbufferten med data från den angivna positionen, och egenskapen bytesAvailable kan anges till 0. Vänta på en complete-händelse innan du använder en read-metod för att läsa data, eller vänta på en progress-händelse och kontrollera egenskapen bytesAvailable innan du använder en read-metod.

import flash.fileSystem.*;
import flash.utils.ByteArray;
import flash.events.Event;

var sourceFile:File = File.documentsDirectory.resolvePath("Apollo Test/test.txt");
var stream:FileStream = new FileStream();
stream.addEventListener(Event.COMPLETE, readBytes);
stream.openAsync(sourceFile, FileMode.READ);

function readBytes(e:Event):void {
    var bytes:ByteArray = new ByteArray();
    trace("position 0:", stream.position); // 0
    bytes[0] = stream.readByte();
    trace("position 1:", stream.position); // 1
    fileStream.readBytes(bytes, stream.position, 4); 
    trace("position 2:", stream.position); // 5
    stream.close();
}

Den minsta datamängd som ska läsas från disken när filer läses asynkront.

Den här egenskapen anger hur mycket data en asynkron ström försöker läsa förbi den aktuella positionen. Data läses i block baserat på filsystemets sidstorlek. Om du då anger readAhead som 9 000 på ett system med en sidstorlek på 8 kB (8 192 byte) läser miljön 2 block (eller 16 384 byte) framåt i taget. Standardvärdet för den här egenskapen är oändlighet: som standard läses en fil som har öppnats för asynkron läsning till slutet av filen.

Läsning av data från läsbufferten ändrar inte värdet för egenskapen readAhead. Efterhand som data läses från bufferten läses nya data in och fyller på läsbufferten.

Egenskapen readAhead påverkar inte filer som öppnas synkront.

När data läses in asynkront skickar FileStream-objektet progress-händelser. Kontrollera att det antal byte som behövs är tillgängliga i händelsehanterarmetoden för händelsen progress (genom att kontrollera egenskapen bytesAvailable) och läs sedan data från läsbufferten med en read-metod.

import flash.filesystem.*;

var file:File = File.desktopDirectory.resolvePath("test.txt");
var fileStream:FileStream = new FileStream();
fileStream.readAhead = 100;
fileStream.addEventListener(ProgressEvent.PROGRESS, readProgressHandler)
fileStream.openAsync(file, FileMode.READ);
var results:ByteArray;

function readProgressHandler(event:ProgressEvent):void {
    if (fileStream.bytesAvailable >= 100) {
        fileStream.readBytes(results, 0, 100);
    }
}

Skapar ett FileStream-objekt. Använd metoden open() eller openAsync() för att öppna en fil.

Relaterade API-element

Stänger FileStream-objektet.

Du kan inte läsa eller skriva data efter att metoden close() har anropats. Om filen öppnades asynkront (FileStream-objektet använde openAsync() för att öppna filen), och metoden close() anropas, skickar objektet händelsen close.

Om du avslutar programmet stängs alla filer som är associerade med FileStream-objekt i programmet automatiskt. Det är emellertid bäst att registrera programmet för en closed-händelse för alla FileStream-objekt, som öppnas asynkront och har väntande data som ska skrivas, innan du avslutar programmet (för att försäkra dig om att dessa data verkligen skrivs).

Du kan återanvända FileStream-objektet genom att anropa metoden open() eller openAsync(). Då stängs alla filer som är associerade med FileStream-objektet utan att objektet skickar close-händelsen.

För ett FileStream-objekt som öppnas asynkront (med metoden openAsync()) gäller, att även om händelsen close() anropas för ett FileStream-objekt, och egenskaper och variabler som refererar till objektet tas bort, skräpsamlas inte FileStream-objektet så länge det finns väntande åtgärder och händelsehanterare har registrerats för att slutföra åtgärderna. Du bör särskilt tänka på att ett FileStream-objekt som i övrigt saknar referenser kommer att finnas kvar så länge något av följande är möjligt:

• För filläsningsåtgärder, så länge slutet inte har nåtts (och händelsen complete inte har skickats).
• Utdata är fortfarande tillgängliga för skrivning, och utdatarelaterade händelser (som händelsen outputProgress eller ioError) har registrerade händelseavlyssnare.

Relaterade API-element

import flash.filesystem.*;
import flash.events.Event;
            
var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.openAsync(file, FileMode.WRITE);
fileStream.writeUTFBytes("Hello");
fileStream.addEventListener(Event.CLOSE, fileClosed);
fileStream.close();

function fileClosed(event:Event):void {
    trace("closed");
}            

import flash.filesystem.*;
            
var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.WRITE);
fileStream.writeUTF("Hello");
fileStream.close();

Öppnar FileStream-objektet synkront och pekar på filen som har angetts av file-parametern.

Om FileStream-objektet redan är öppet kommer filen att stängas innan den öppnas på nytt, om metoden anropas och inga ytterligare händelser (inklusive close) ska skickas för den tidigare öppna filen.

På system med stöd för fillåsning är en fil som öppnas i ”skrivläge” eller ”uppdateringsläge” (FileMode.WRITE eller FileMode.UPDATE) inte läsbar förrän den stängs.

När du är klar med alla åtgärder för filen anropar du metoden close() för FileStream-objektet. På vissa operativsystem finns en gräns för hur många filer som kan vara öppna samtidigt.

Parametrar

Relaterade API-element

import flash.filesystem.*;

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.READ);
var str:String = fileStream.readMultiByte(file.size, File.systemCharset);
trace(str);
fileStream.close();

Öppnar FileStream-objektet asynkront och pekar på filen som anges av file-parametern.

Om FileStream-objektet redan är öppet kommer filen att stängas innan den öppnas på nytt, om metoden anropas och inga ytterligare händelser (inklusive close) ska skickas för den tidigare öppna filen.

Om parametern fileMode anges som FileMode.READ eller FileMode.UPDATE läser AIR data till indatabufferten så fort filen öppnas, och progress- och open-händelser skickas efterhand som data läses till indatabufferten.

På system med stöd för fillåsning är en fil som öppnas i ”skrivläge” eller ”uppdateringsläge” (FileMode.WRITE eller FileMode.UPDATE) inte läsbar förrän den stängs.

När du är klar med alla åtgärder för filen anropar du metoden close() för FileStream-objektet. På vissa operativsystem finns en gräns för hur många filer som kan vara öppna samtidigt.

Parametrar

Relaterade API-element

import flash.filesystem.*;
import flash.events.Event;

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.addEventListener(Event.COMPLETE, fileCompleteHandler)
fileStream.openAsync(file, FileMode.READ);

function fileCompleteHandler(event:Event):void {
    var str:String = fileStream.readMultiByte(fileStream.bytesAvailable, File.systemCharset);
    trace(str);
    fileStream.close();
}

Läser ett booleskt värde från filflödet, byteflödet eller bytearrayen. En enkel byte läses och true returneras om bytevärdet inte är noll, i annat fall false.

Läser en signerad byte med tecken från filflödet, byteflödet eller bytearrayen.

Läser så många databyte som anges av parametern length från filflödet, byteflödet eller bytearrayen. Bytena läses till det ByteArray-objekt som anges av parametern bytes med start vid den position som anges av offset.

Parametrar

Läser ett IEEE 754-flyttal med dubbel precision från filflödet, byteflödet eller bytearrayen.

Läser ett IEEE 754-flyttal med enkel precision från filflödet, byteflödet eller bytearrayen.

Läser ett signerat 32-bitars heltal med tecken från filflödet, byteflödet eller bytearrayen.

Skriver en multibyte-sträng med den angivna längden från filströmmen, byteströmmen eller bytearrayen med den angivna teckenuppsättningen.

Parametrar

Relaterade API-element

Läser ett objekt till filflödet, byteflödet eller bytearrayen kodat i serialiserat AMF-format.

Relaterade API-element

Läser ett signerat 16-bitars heltal med tecken från filflödet, byteflödet eller bytearrayen.

Läser en osignerad byte med tecken från filflödet, byteflödet eller bytearrayen.

Läser ett osignerat 32-bitars heltal med tecken från filflödet, byteflödet eller bytearrayen.

Läser ett osignerat 16-bitars heltal med tecken från filflödet, byteflödet eller bytearrayen.

Läser en UTF-8-sträng från filflödet, byteflödet eller bytearrayen. Strängen antas inledas av typen short utan tecken som visar längden i byte.

Den här metoden liknar metoden readUTF() i Java^® IDataInput-gränssnittet.

Läser en sekvens UTF-8-byte från byteflödet eller bytearrayen och returnerar en sträng.

Parametrar

Trunkerar filen vid den position som anges av egenskapen position i FileStream-objektet.

Byte från den position som anges av egenskapen position till slutet av filen tas bort. Filen måste vara öppen för skrivning.

Relaterade API-element

import flash.filesystem.*;

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.open(file, FileMode.UPDATE);
if (file.size > 100) {
    fileStream.position = 100;
    fileStream.truncate();
}
fileStream.close();

var file:File = File.documentsDirectory;
file = file.resolvePath("Apollo Test/test.txt");
var fileStream:FileStream = new FileStream();
fileStream.openAsync(file, FileMode.UPDATE);
trace("start", file.size)
if (file.size > 100) {
    fileStream.position = 100;
    fileStream.truncate();
}
fileStream.addEventListener(Event.CLOSE, fileClosed);
fileStream.close();
function fileClosed(event:Event):void {
    trace("closed", file.size); 
}

Skriver ett booleskt värde. En enkel byte skrivs i enlighet med parametern value, antingen 1 om värdet är true eller 0 om värdet är false.

Parametrar

Skriver en byte. De första 8 bitarna i parametern används, de övre 24 bitarna ignoreras.

Parametrar

Skriver en bytesekvens från den angivna bytearrayen, bytes, med början på den byte som anges av offset (med ett nollbaserat index) och med den längd som anges av length, till filströmmen, byteströmmen eller bytearrayen.

Om parametern length utelämnas används standardlängden 0 och hela bufferten med början på offset skrivs. Om parametern offset också utelämnas skrivs hela bufferten.

Om parametern offset eller parameternlength är utanför intervallet kläms de ihop i början och slutet av bytes-arrayen

Parametrar

Skriver ett IEEE 754-flyttal med dubbel precision (64 bitar).

Parametrar

Skriver ett IEEE 754-flyttal med enkel precision (32 bitar).

Parametrar

Skriver ett 32-bitars heltal med tecken.

Parametrar

Skriver en flerbytesträng till filflödet, byteflödet eller bytearrayen med den angivna teckenuppsättningen.

Parametrar

Relaterade API-element

Skriver ett objekt till filflödet, byteflödet eller bytearrayen i serialiserat AMF-format.

Parametrar

Relaterade API-element

Skriver ett 16-bitars heltal. De första 16 bitarna i parametern används, de övre 16 bitarna ignoreras.

Parametrar

Skriver ett 32-bitars heltal utan tecken.

Parametrar

Skriver en UTF-8-sträng från filflödet, byteflödet eller bytearrayen. Först skrivs längden på en UTF-8-sträng i byte, som ett 16-bitars heltal, följt av de byte som representerar strängens tecken.

Parametrar

Skriver en UTF-8-sträng. Liknar writeUTF() men använder inte ett ord på 16-bitar som prefix i strängen.

Parametrar

Anger att strömmen har stängs av ett explicit anrop till close()-metoden.

Den här händelsen har följande egenskaper:

Relaterade API-element

Anger att slutet av strömmen har nåtts.

Den här händelsen har följande egenskaper:

Relaterade API-element

Anger att ett fel inträffade under den asynkrona in-/utdataåtgärden.

Den här händelsen har följande egenskaper:

Anger att buffrade data har skrivits till filen.

Den här händelsen har följande egenskaper:

Anger att det finns nya data i strömmen.

Den här händelsen har följande egenskaper: