FileStream  - AS3

Renvoie le nombre d’octets de données disponibles pour la lecture dans le tampon de saisie. Le code utilisateur doit appeler bytesAvailable pour garantir que les données disponibles sont suffisantes avant leur lecture à l’aide de l’une des méthodes read.

Ordre d’octet des données, à savoir la constante BIG_ENDIAN ou LITTLE_ENDIAN de la classe Endian.

Spécifie si le format AMF3 ou AMF0 est utilisé lors de l’écriture ou de la lecture de données binaires avec la méthode readObject() ou writeObject().

La valeur est une constante extraite de la classe ObjectEncoding. Par défaut, le format AMF3 est utilisé.

Eléments de l’API associés

Position actuelle dans le fichier.

Cette valeur est modifiée dans l’un des cas suivants :

• Lorsque vous définissez la propriété explicitement
• Lors d’une lecture de l’objet FileStream (avec l’une les méthodes de lecture)
• Lors d’une écriture dans l’objet FileStream

La position est définie sous forme numérique (à la place d’uint) pour que les fichiers dont la longueur est supérieure à 2³² octets puissent être pris en charge. La valeur de cette propriété est toujours un nombre entier inférieur à 2⁵³. Si vous définissez cette valeur sur un nombre décimal, la valeur est arrondie au nombre entier le plus proche.

Lorsqu’un fichier est lu de façon asynchrone, si vous définissez la propriété position, l’application commence à remplir la mémoire tampon de lecture par les données en commençant à la position spécifiée, et la propriété bytesAvailable peut être définie sur 0. Attendez un événement complete avant d’utiliser une méthode de lecture pour lire des données ; ou attendez un événement progress et vérifiez la propriété bytesAvailable avant d’utiliser une méthode de lecture.

Plus d’exemples

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

Quantité minimale de données à lire à partir du disque lors de la lecture asynchrone des fichiers.

Cette propriété spécifie la quantité de données qu’un flux asynchrone tentera de lire à partir de la position actuelle. Les données sont lues en blocs en fonction de la taille de page du système de fichiers. Ainsi, si vous définissez readAhead sur 9 000 sur un système informatique dont la taille de page est de 8 Ko (8 192 octets), le moteur d’exécution lit 2 blocs ou 16 384 octets à la fois. La valeur par défaut de cette propriété est infinity : par défaut, un fichier ouvert pour une lecture asynchrone est lu jusqu’à la fin du fichier.

La lecture de données dans la mémoire tampon de lecture ne change pas la valeur de la propriété readAhead. Lorsque des données sont lues dans la mémoire tampon, de nouvelles données sont lues pour remplir la mémoire tampon de lecture.

La propriété readAhead n’a aucune incidence sur un fichier ouvert de façon synchrone.

Lorsque des données sont lues de façon asynchrone, l’objet FileStream déclenche des événements progress. Dans la méthode du gestionnaire de l’événement progress, vérifiez que le nombre requis d’octets est disponible (en vérifiant la propriété bytesAvailable), puis lisez les données dans la mémoire tampon de lecture à l’aide d’une méthode de lecture.

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

Crée un objet FileStream. Utilise la méthode open() ou openAsync() pour ouvrir un fichier.

Eléments de l’API associés

Ferme l’objet FileStream.

Vous ne pouvez plus lire ni écrire des données après avoir appelé la méthode close(). Si le fichier a été ouvert de façon asynchrone (l’objet FileStream a utilisé la méthode openAsync() pour ouvrir le fichier), un appel à la méthode close() entraîne la distribution de l’événement close par l’objet.

La fermeture de l’application entraîne la fermeture automatique de tous les fichiers associés aux objets FileStream de l’application. Toutefois, il est préférable d’enregistrer un événement closed pour tous les objets FileStream ouverts de façon asynchrone et qui ont des données en attente d’écriture avant de fermer l’application (afin de s’assurer que ces données soient écrites).

Vous pouvez réutiliser l’objet FileStream en appelant la méthode open() ou la méthode openAsync(). Tous les fichiers associés à l’objet FileStream sont ainsi fermés, mais l’objet ne déclenche pas l’événement close.

Dans le cas d’un objet FileStream ouvert de façon asynchrone (avec la méthode openAsync()), même si vous appelez l’événement close() pour un objet FileStream et supprimez les propriétés et les variables qui référence l’objet, l’objet FileStream n’est pas nettoyé tant que des opérations sont en cours et que des gestionnaires d’événement sont enregistrés. En particulier, un objet FileStream non référencé autrement persiste tant que l’un des scénarios suivants est encore possible :

• Pour les opérations de lecture de fichiers, la fin du fichier n’a pas été atteinte (et l’événement complete n’a pas été déclenché).
• Des données de sortie sont toujours disponibles pour l’écriture et des événements liés à la sortie (par exemple outputProgress ou ioError) ont des écouteurs d’événement enregistrés.

Eléments de l’API associés

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

Ouvre l’objet FileStream de façon synchrone, en pointant vers le fichier spécifié par le paramètre file.

Si l’objet FileStream est déjà ouvert, un appel à la méthode ferme le fichier avant l’ouverture et aucun autre événement (y compris close) n’est délivré pour le fichier précédemment ouvert.

Dans les systèmes qui prennent en charge le verrouillage de fichiers, un fichier ouvert en mode « écriture » ou en mode « mise à jour » (FileMode.WRITE ou FileMode.UPDATE) n’est plus lisible jusqu’à sa fermeture.

Une fois que vous avez terminé de réaliser des opérations sur le fichier, appelez la méthode close() de l’objet FileStream. Certains systèmes d’exploitation limitent le nombre de fichiers ouverts simultanément.

Paramètres

Plus d’exemples

Eléments de l’API associés

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

Ouvre l’objet FileStream de façon asynchrone, en pointant vers le fichier spécifié par le paramètre file.

Si l’objet FileStream est déjà ouvert, un appel à la méthode ferme le fichier avant l’ouverture et aucun autre événement (y compris close) n’est délivré pour le fichier précédemment ouvert.

Si le paramètre fileMode est défini sur FileMode.READ ou sur FileMode.UPDATE, AIR lit les données dans la mémoire tampon d’entrée dès l’ouverture du fichier, et des événements progress et open sont déclenchés au fur et à mesure de la lecture des données dans la mémoire tampon d’entrée.

Dans les systèmes qui prennent en charge le verrouillage de fichiers, un fichier ouvert en mode « écriture » ou en mode « mise à jour » (FileMode.WRITE ou FileMode.UPDATE) n’est plus lisible jusqu’à sa fermeture.

Une fois que vous avez terminé de réaliser des opérations sur le fichier, appelez la méthode close() de l’objet FileStream. Certains systèmes d’exploitation limitent le nombre de fichiers ouverts simultanément.

Paramètres

Plus d’exemples

Eléments de l’API associés

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

Lit une valeur booléenne dans le flux de fichiers, le flux d’octets ou le tableau d’octets. Un seul octet est lu, et la valeur true est renvoyée s’il n’est pas nul, false dans le cas contraire.

Lit un octet signé dans le flux de fichiers, le flux d’octets ou le tableau d’octets.

Lit le nombre d’octets de données spécifié par le paramètre length dans le flux de fichiers, le flux d’octets ou le tableau d’octets. Les octets sont lus dans l’objet ByteArray spécifié par le paramètre bytes, à partir de la position indiquée par offset.

Paramètres

Plus d’exemples

Lit un nombre à virgule flottante à deux décimales, conforme à IEEE 754, extrait du flux de fichiers, du flux d’octets ou du tableau d’octets.

Lit un nombre à virgule flottante à une décimale, conforme à IEEE 754, extrait du flux de fichiers, du flux d’octets ou du tableau d’octets.

Lit un entier signé de 32 bits extrait du flux de fichiers, du flux d’octets ou du tableau d’octets.

Lit une chaîne multi-octets de longueur spécifiée dans le flux de fichiers, le flux d’octets ou le tableau d’octets en utilisant le jeu de caractères spécifié.

Paramètres

Eléments de l’API associés

Lit un objet codé au format AMF sérialisé dans le flux de fichiers, le flux d’octets ou le tableau d’octets.

Eléments de l’API associés

Lit un entier signé de 16 bits extrait du flux de fichiers, du flux d’octets ou du tableau d’octets.

Lit un octet non signé dans le flux de fichiers, le flux d’octets ou le tableau d’octets.

Lit un entier non signé de 32 bits extrait du flux de fichiers, du flux d’octets ou du tableau d’octets.

Lit un entier non signé de 16 bits extrait du flux de fichiers, du flux d’octets ou du tableau d’octets.

Lit une chaîne UTF-8 dans le flux de fichiers, le flux d’octets ou le tableau d’octets. La chaîne doit être précédée d’un caractère non signé indiquant la longueur en octets.

Cette méthode est similaire à la méthode readUTF() de l’interface IDataInput Java^®.

Lit une séquence d’octets UTF-8 dans le flux ou le tableau d’octets et renvoie une chaîne.

Paramètres

Tronque le fichier placé à la position spécifiée par la propriété position de l’objet FileStream.

Les octets situés entre la position spécifiée par la propriété position et la fin du fichier sont supprimés. Le fichier doit être ouvert pour l’écriture.

Eléments de l’API associés

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

Ecrit une valeur booléenne. Un seul octet est écrit, conformément au paramètre value, soit 1 si true ou 0 si false.

Paramètres

Ecrit un octet. Les 8 bits inférieurs du paramètre sont utilisés. Les 24 bits supérieurs ne sont pas pris en compte.

Paramètres

Ecrit une séquence d’octets à partir du tableau d’octets ou des octets spécifiés, en partant de l’octet spécifié par l’offset (à l’aide d’un index de base zéro) dont la longueur est indiquée par le paramètre length dans le flux de fichiers ou d’octets, ou le tableau d’octets.

Si le paramètre length est omis, la longueur par défaut est utilisée (à savoir 0) et tout le contenu de la mémoire tampon à partir de offset est écrit. Si le paramètre offset est également omis, toute la mémoire tampon est écrite.

Si les paramètres offset ou length ne sont pas compris dans la plage supportée, ils sont réglés sur le début et la fin du tableau d’octets (bytes).

Paramètres

Ecrit un nombre à virgule flottante à deux décimales (64 bits) et conforme à IEEE 754.

Paramètres

Ecrit un nombre à virgule flottante à une décimale (32 bits) et conforme à IEEE 754.

Paramètres

Ecrit un entier signé de 32 bits.

Paramètres

Ecrit une chaîne multi-octets dans le flux de fichiers, le flux d’octets ou le tableau d’octets en utilisant le jeu de caractères spécifié.

Paramètres

Eléments de l’API associés

Ecrit un objet codé au format AMF sérialisé dans le flux de fichiers, le flux d’octets ou le tableau d’octets.

Paramètres

Eléments de l’API associés

Ecrit un entier de 16 bits. Les 16 bits inférieurs du paramètre sont utilisés. Les 16 bits supérieurs ne sont pas pris en compte.

Paramètres

Ecrit un entier non signé de 32 bits.

Paramètres

Ecrit une chaîne UTF-8 dans le flux de fichiers, le flux d’octets ou le tableau d’octets. La longueur de la chaîne UTF-8 exprimée en octets est d’abord écrite sous forme d’entier de 16 bits, suivi des octets représentant les caractères de la chaîne.

Paramètres

Ecrit une chaîne UTF-8. Comme writeUTF(), mais n’insère pas dans la chaîne un préfixe correspondant à un mot de 16 bits.

Paramètres

Indique que le flux a été fermé par un appel explicite à la méthode close().

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Indique que la fin du flux a été atteint.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Indique qu’une erreur s’est produite lors d’une opération d’E/S de fichier asynchrone.

Les propriétés de cet événement sont les suivantes :

Indique que les données placées en mémoire tampon ont été écrites dans le fichier.

Les propriétés de cet événement sont les suivantes :

Signale la disponibilité de nouvelles données dans le flux.

Les propriétés de cet événement sont les suivantes :