FileStream  - AS3

Zwraca liczbę bajtów, które można odczytać z bufora wejściowego. Kod użytkownika musi wywołać właściwość bytesAvailable, aby upewnić się, że dostępna jest wystarczająca ilość danych, zanim nastąpi próba ich odczytania za pomocą jednej z metod read.

Porządek bajtów, określony za pomocą stałej BIG_ENDIAN lub LITTLE_ENDIAN z klasy Endian.

Określa, który z formatów (AMF3 lub AMF0) zostanie użyty podczas zapisywania lub odczytywania danych binarnych za pomocą metod readObject() lub writeObject().

Wartością domyślną jest stała z klasy ObjectEncoding. Domyślnie używany format to AMF3.

Powiązane elementy interfejsu API

Bieżące położenie w pliku.

Wartość ta może być modyfikowana w następujący sposób:

• Kiedy właściwość jest ustawiana jawnie.
• Podczas odczytu z obiektu FileStream (za pomocą jednej z metod odczytu).
• Podczas zapisu do obiektu FileStream.

Położenie jest określane jako liczba (zamiast jednostek), aby obsłużyć pliki o długości większej niż 2³² bajta. Wartość tej właściwości jest zawsze liczbą całkowitą mniejszą niż 2⁵³. Jeżeli jako wartość zostanie ustawiona liczba z częścią ułamkową, to jest ona zaokrąglana w dół do najbliższej liczby całkowitej.

Podczas asynchronicznego odczytu pliku, jeżeli ustawiona zostanie właściwość position, aplikacja rozpocznie wypełnianie bufora odczytu danymi rozpoczynającymi się w określonej pozycji oraz właściwość bytesAvailable może być ustawiona na 0. Przed użyciem metody do odczytu danych należy poczekać na zdarzenie complete lub na zdarzenie progress i sprawdzić właściwość bytesAvailable.

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();
}

Minimalna ilość danych do odczytania z dysku podczas asynchronicznego czytania plików.

Właściwość ta określa ilość danych, jaką strumień asynchroniczny usiłuje odczytać za bieżącą pozycją. Czytanie danych następuje w blokach zależnych od rozmiaru strony systemu plików. Oznacza to, że jeśli dla właściwości readAhead zostanie ustawiona wartość 9000 na komputerze z systemem plików mającym rozmiar strony 8 KB (8192 bajty), środowisko wykonawcze przeczyta dwa bloki — 16384 bajty naraz. Domyślną wartością tej właściwości jest nieskończoność: domyślnie plik otwarty do odczytu asynchronicznego odczyta dane do końca pliku.

Odczyt danych z bufora odczytu nie zmienia wartości właściwości readAhead. Podczas odczytu danych z bufora nowe dane są odczytywane w celu ponownego napełnienia bufora.

Właściwość readAhead nie ma wpływu na plik, który jest otwarty synchronicznie.

Kiedy dane są odczytywane asynchronicznie, obiekt FileStream wywołuje zdarzenia progress. W metodzie modułu obsługi zdarzeń dla zdarzenia progress należy sprawdzić, czy jest dostępna wymagana ilość bajtów (sprawdzając właściwość bytesAvailable) i następnie odczytać dane z bufora odczytu za pomocą metody odczytu.

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);
    }
}

Tworzy obiekt FileStream. Aby otworzyć plik, należy użyć metody open() lub openAsync().

Powiązane elementy interfejsu API

Zamyka obiekt FileStream.

Po wywołaniu metody close() nie można odczytywać ani zapisywać danych. Jeżeli plik był otwarty asynchronicznie (obiekt FileStream do otwarcia pliku użył metody openAsync()), wywołanie metody close() spowoduje wywołanie przez obiekt zdarzenia close.

Zamknięcie aplikacji automatycznie zamyka wszystkie pliki skojarzone z obiektami FileStream w aplikacji. Dobrą praktyką jest zarejestrowanie przed zamknięciem aplikacji detektorów zdarzenia closed dla wszystkich otwartych asynchronicznie obiektów FileStream (w celu zagwarantowania zapisu danych).

Można ponownie użyć obiektu FileStream przez wywołanie metody open() lub metody openAsync(). Zamknie to każdy plik skojarzony z obiektem FileStream, lecz obiekt nie wywoła zdarzenia close.

Dla obiektu FileStream otworzonego asynchronicznie (za pomocą metody openAsync()), nawet jeżeli wywołane zostało zdarzenie close() dla obiektu FileStream oraz usunięte właściwości i zmienne, do których odwoływał się ten obiekt, obiekt FileStream nie jest gromadzony (jako element niepotrzebny), dopóki trwające operacje i moduły obsługi zdarzeń są rejestrowane do czasu ich ukończenia. W szczególności obiekt FileStream, do którego nie istnieją odwołania, będzie istniał tak długo, jak spełniony będzie jeden z następujących warunków:

• dla operacji odczytu plików, koniec pliku nie został osiągnięty (zdarzenie complete nie zostało wywołane).
• dane wyjściowe są wciąż dostępne do zapisu oraz zdarzenia związane z wyjściem (takie jak zdarzenie outputProgress lub zdarzenie ioError) mają zarejestrowane detektory zdarzeń.

Powiązane elementy interfejsu API

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();

Otwiera synchronicznie obiekt FileStream, wskazując na plik określony parametrem file.

Jeżeli obiekt FileStream jest już otwarty, wywołanie metody zamyka plik przed otwarciem, a do uprzednio otwartego pliku nie są przesyłane żadne zdarzenia (w tym close).

W systemach obsługujacych blokowanie plików plik otwarty w trybie „write” lub „update” (FileMode.WRITE lub FileMode.UPDATE) nie może być czytany do czasu, aż zostanie zamknięty.

Po zakończeniu wykonywania operacji na pliku należy wywołać metodę close() obiektu FileStream. W niektórych systemach operacyjnych liczba jednocześnie otwartych plików jest ograniczona.

Parametry

Powiązane elementy interfejsu API

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();

Otwiera asynchronicznie obiekt FileStream, wskazując na plik określony parametrem file.

Jeżeli obiekt FileStream jest już otwarty, wywołanie metody zamyka plik przed otwarciem, a do uprzednio otwartego pliku nie są przesyłane żadne zdarzenia (w tym close).

Jeżeli parametr fileMode jest ustawiony na wartość FileMode.READ lub FileMode.UPDATE, środowisko AIR po otworzeniu pliku odczytuje dane do bufora wejściowego i zdarzenia progress oraz open, są wywoływane, gdy dane są odczytywane do bufora wejściowego.

W systemach obsługujacych blokowanie plików plik otwarty w trybie „write” lub „update” (FileMode.WRITE lub FileMode.UPDATE) nie może być czytany do czasu, aż zostanie zamknięty.

Po zakończeniu wykonywania operacji na pliku należy wywołać metodę close() obiektu FileStream. W niektórych systemach operacyjnych liczba jednocześnie otwartych plików jest ograniczona.

Parametry

Powiązane elementy interfejsu API

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();
}

Czyta ze strumienia pliku, strumienia bajtów lub z tablicy bajtów wartość typu Boolean. Po odczytaniu jednego bajta metoda zwraca true, jeśli bajt jest wartością niezerową; w przeciwnym wypadku false.

Czyta bajt ze znakiem ze strumienia pliku, ze strumienia bajtów lub z tablicy bajtów.

Pozwala odczytać ze strumienia pliku, strumienia bajtów lub z tablicy bajtów liczbę bajtów określoną przez parametr length. Bajty są odczytywane do obiektu ByteArray określonego przez parametr bytes, a odczyt rozpoczyna się w miejscu określonym przez parametr offset.

Parametry

Czyta liczbę zmiennoprzecinkową o podwójnej dokładności (wg normy IEEE 754) ze strumienia pliku, ze strumienia bajtów lub z tablicy bajtów.

Czyta ze strumienia pliu, strumienia bajtów lub z tablicy bajtów liczbę zmiennoprzecinkową o zwykłej dokładności (IEEE 754).

Czyta ze strumienia pliku, strumienia bajtów lub z tablicy bajtów 32-bitową liczbę całkowitą ze znakiem.

Czyta wielobajtowy ciąg o określonej długości ze strumienia pliku, strumienia bajtów lub tablicy bajtowej przy użyciu określonego zestawu znaków.

Parametry

Powiązane elementy interfejsu API

Czyta ze strumienia pliku, strumienia bajtów lub tablicy bajtów obiekt zakodowany w formacie serializowanym AMF.

Powiązane elementy interfejsu API

Czyta 16-bitową liczbę całkowitą ze znakiem ze strumienia pliku, ze strumienia bajtów lub z tablicy bajtów.

Czyta ze strumienia pliku, strumienia bajtów lub z tablicy bajtów bajt bez znaku.

Czyta ze strumienia pliku, strumienia bajtów lub z tablicy bajtów 32-bitową liczbę całkowitą bez znaku.

Czyta ze strumienia pliku, ze strumienia bajtów lub z tablicy bajtów 16-bitową liczbę całkowitą bez znaku.

Czyta ze strumienia pliku, strumienia bajtów lub tablicy bajtów ciąg znaków UTF-8. Zakłada się, że ciąg jest poprzedzony prefiksem w postaci liczby typu short bez znaku, która określa długość ciągu w bajtach.

Ta metoda działa podobnie jak metoda readUTF() w interfejsie Java^® IDataInput.

Czyta ze strumienia bajtów lub tablicy bajtów sekwencję bajtów UTF-8 i zwraca ciąg.

Parametry

Obcina plik w miejscu określonym przez właściwość position obiektu FileStream.

Bajty od pozycji określonej przez właściwość position do końca pliku zostaną usunięte. Plik musi być otwarty do zapisu.

Powiązane elementy interfejsu API

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); 
}

Zapisuje wartość typu Boolean. Zapisany zostanie pojedynczy bajt zgodnie z parametrem value — 1 dla true lub 0 dla false.

Parametry

Zapisuje bajt. Używanych jest 8 najmniej znaczących bitów parametru; bardziej znaczące 24 bitów jest ignorowane.

Parametry

Zapisuje sekwencję bajtów z określonej tablicy bajtowej bytes, rozpoczynając od bajta określanego przez parametr offset (indeksowanego od zera) o długości określonej w parametrze length do strumienia pliku, strumienia bajtów lub tablicy bajtowej.

Jeśli parametr length został pominięty, używana jest domyślna długość 0 i zapisywany jest cały bufor począwszy od miejsca określonego parametrem offset. Jeśli parametr offset również został pominięty, zapisany zostanie cały bufor.

Jeśli wartość parametru offset lub length jest poza zakresem, parametry zostaną ograniczone do początku i końca tablicy bytes.

Parametry

Zapisuje liczbę zmiennoprzecinkową o podwójnej precyzji (64 bity) wg normy IEEE 754.

Parametry

Zapisuje liczbę zmiennoprzecinkową o pojedynczej precyzji (32 bity) wg normy IEEE 754.

Parametry

Zapisuje 32-bitową liczbę całkowitą ze znakiem.

Parametry

Zapisuje wielobajtowy ciąg do strumienia pliku, strumienia bajtów lub tablicy bajtowej, przy użyciu określonego zestawu znaków.

Parametry

Powiązane elementy interfejsu API

Zapisuje w strumieniu pliku, strumieniu bajtów lub w tablicy bajtów obiekt zakodowany w formacie serializowanym AMF.

Parametry

Powiązane elementy interfejsu API

Zapisuje 16-bitową liczbę całkowitą. Używanych jest 16 najmniej znaczących bitów parametru; bardziej znaczące 16 bitów jest ignorowane.

Parametry

Zapisuje 32-bitową liczbę całkowitą bez znaku.

Parametry

Zapisuje do strumienia pliku, strumienia bajtów lub tablicy bajtów ciąg znaków UTF-8. Długość ciągu znaków UTF-8 w bajtach jest zapisywana na początku jako 16-bitowa wartość integer, a po niej następują bajty reprezentujące znaki ciągu znaków.

Parametry

Zapisuje ciąg znaków UTF-8. Podobnie, jak writeUTF(), ale nie umieszcza przed ciągiem znaków przedrostka w postaci słowa zawierającego 16 bitów.

Parametry

Wskazuje na zamknięcie strumienia przez jawne wywołanie do metody close().

To zdarzenie ma następujące właściwości:

Powiązane elementy interfejsu API

Informuje o osiągnięciu końca strumienia.

To zdarzenie ma następujące właściwości:

Powiązane elementy interfejsu API

Wskazuje, że wystąpił błąd podczas operacji wej./wyj. pliku asynchronicznego.

To zdarzenie ma następujące właściwości:

Informuje o zapisaniu buforowanych danych do pliku.

To zdarzenie ma następujące właściwości:

Informuje o dostępności nowych danych w strumieniu.

To zdarzenie ma następujące właściwości: