FileStream

Пакет	flash.filesystem
Класс	public class FileStream
Наследование	FileStream EventDispatcher Object
Реализует	IDataInput, IDataOutput

Версии среды выполнения:

AIR 1.0

Объект FileStream используется для чтения и записи файлов. Файлы можно открывать в синхронном режиме с помощью метода open() или в асинхронном с помощью метода openAsync().

Преимущество открытия файлов в асинхронном режиме состоит в том, что пока Adobe AIR выполняет чтение и запись в фоновом режиме, может исполняться и другой код. При открытии в асинхронном режиме события progress вызываются по мере выполнения операций.

Поведение объекта File, открываемого в асинхронном режиме, похоже на поведение объекта ByteArray, а поведение файла, открываемого в асинхронном режиме, похоже на поведение объекта Socket или URLStream. Когда объект File открывается в синхронном режиме, вызывающий оператор приостанавливает работу, пока запрошенные данные считываются или записываются в файл. Когда же он открывается в асинхронном режиме, все записываемые данные немедленно помещаются в буфер и записываются в файл позднее.

Независимо от того, в синхронном или асинхронном режиме выполняется чтение, в действительности методы чтения являются синхронными. В обоих случаях считывание производится из данных, которые «доступны» в текущий момент времени. Разница в том, что при синхронном чтении все данные доступны постоянно, а при асинхронном данные становятся доступны по мере того, как они передаются в буфер считывания. В любом случае, данные, которые в настоящий момент можно считать синхронным способом, представлены свойством bytesAvailable.

Приложение, обрабатывающее вводимые данные в асинхронном режиме, обычно ожидает событий progress и использует данные по мере того, как они становятся доступны, через вызов методов чтения. С другой стороны, приложение может просто дождаться, когда станут доступны все данные (событие complete), и как только событие complete будет выполнено, обработать все данные сразу.

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		bytesAvailable : uint [только для чтения] Возвращает число байтов данных, доступных для чтения во входном буфере.	FileStream
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		endian : String Порядок байтов данных, константа BIG_ENDIAN или LITTLE_ENDIAN класса Endian.	FileStream
		objectEncoding : uint Указывает, какой формат, AMF3 или AMF0, используется для записи или чтения бинарных данных методом readObject() или writeObject().	FileStream
		position : Number Текущее положение в файле.	FileStream
		readAhead : Number Минимальный объем данных, читаемых с диска в асинхронном режиме.	FileStream

Общедоступные методы

Скрыть унаследованные общедоступные методы

Показать унаследованные общедоступные методы

	Метод		Определено
		FileStream() Создает объект FileStream.	FileStream
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.	EventDispatcher
		close():void Закрывает объект FileStream.	FileStream
		dispatchEvent(event:Event):Boolean Посылает событие в поток событий.	EventDispatcher
		hasEventListener(type:String):Boolean Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события.	EventDispatcher
		hasOwnProperty(name:String):Boolean Показывает, определено ли заданное свойство для объекта.	Object
		isPrototypeOf(theClass:Object):Boolean Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.	Object
		open(file:File, fileMode:String):void Открывает объект FileStream в синхронном режиме, указывая на файл, заданный параметром file.	FileStream
		openAsync(file:File, fileMode:String):void Открывает объект FileStream в асинхронном режиме, указывая на файл, заданный параметром file.	FileStream
		propertyIsEnumerable(name:String):Boolean Показывает наличие заданного свойства и его перечисляемость.	Object
		readBoolean():Boolean Считывает логическое значение из потока файлов, байтов или массива байтов.	FileStream
		readByte():int Считывает байт со знаком из потока файлов, байтов или массива байтов.	FileStream
		readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void Считывает число байтов данных, заданное параметром length, из потока файлов, байтов или массива байтов.	FileStream
		readDouble():Number Считывает из потока файлов, байтов или массива байтов число IEEE 754 с двойной точностью и плавающей запятой.	FileStream
		readFloat():Number Считывает из потока файлов, байтов или массива байтов число IEEE 754 с одинарной точностью и плавающей запятой.	FileStream
		readInt():int Считывает из потока файлов, байтов или массива байтов 32-разрядное целое число со знаком.	FileStream
		readMultiByte(length:uint, charSet:String):String Считывает из потока файлов, байтов или массива байтов многобайтовую строку заданной длины с использованием указанного набора символов.	FileStream
		readObject():* Считывает объект из потока файлов, байтов или массива байтов зашифрованный в сериализованном формате AMF.	FileStream
		readShort():int Считывает из потока файлов, байтов или массива байтов 16-разрядное целое число со знаком.	FileStream
		readUnsignedByte():uint Считывает байт без знака из потока файлов, байтов или массива байтов.	FileStream
		readUnsignedInt():uint Считывает из потока файлов, байтов или массива байтов 32-разрядное целое число без знака.	FileStream
		readUnsignedShort():uint Считывает из потока файлов, байтов или массива байтов 16-разрядное целое число без знака.	FileStream
		readUTF():String Считывает из потока файлов, байтов или массива байтов строку UTF-8.	FileStream
		readUTFBytes(length:uint):String Считывает последовательность байтов UTF-8 из потока байтов или массива байтов и возвращает строку.	FileStream
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Удаляет прослушиватель из объекта EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Задает доступность динамического свойства для операций цикла.	Object
		toLocaleString():String Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.	Object
		toString():String Возвращает строковое представление заданного объекта.	Object
		truncate():void Сокращает файл до положения, заданного свойством position объекта FileStream.	FileStream
		valueOf():Object Возвращает элементарное значение заданного объекта.	Object
		willTrigger(type:String):Boolean Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником.	EventDispatcher
		writeBoolean(value:Boolean):void Записывает логическое значение.	FileStream
		writeByte(value:int):void Записывает байт.	FileStream
		writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void Записывает последовательность байтов из заданного массива байтов, начиная с байта, заданного параметром offset (используя индекс с нулевой базой), длиной, заданной параметром length, в поток файлов, байтов или массив байтов.	FileStream
		writeDouble(value:Number):void Записывает число IEEE 754 с двойной точностью (64-разрядное) и плавающей запятой.	FileStream
		writeFloat(value:Number):void Записывает число IEEE 754 с одинарной точностью (32-разрядное) и плавающей запятой.	FileStream
		writeInt(value:int):void Записывает 32-разрядное целое число со знаком.	FileStream
		writeMultiByte(value:String, charSet:String):void Записывает в поток файлов, байтов или массив байтов многобайтовую строку заданной длины с использованием заданного набора символов.	FileStream
		writeObject(object:*):void Записывает объект в поток файлов, байтов или массив байтов в сериализованном формате AMF.	FileStream
		writeShort(value:int):void Записывает 16-разрядное целое число.	FileStream
		writeUnsignedInt(value:uint):void Записывает 32-разрядное целое число без знака.	FileStream
		writeUTF(value:String):void Записывает в поток файлов, байтов или массив байтов строку UTF-8.	FileStream
		writeUTFBytes(value:String):void Записывает строку UTF-8.	FileStream

События

Дополнительные сведения о событиях

Скрыть унаследованные события

Показать унаследованные события

	Сводка	Определено
activate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным.	EventDispatcher
close	Указывает, что поток был закрыт формальным вызовом метода close().	FileStream
complete	Сообщает о достижении конца потока.	FileStream
deactivate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным.	EventDispatcher
ioError	Указывает, что во время выполнения асинхронной операции ввода-вывода произошла ошибка.	FileStream
outputProgress	Сообщает, что запись данных из буфера в файл завершена.	FileStream
progress	Сообщает, что в потоке появились новые доступные данные.	FileStream

Сведения о свойстве

bytesAvailable

свойство

bytesAvailable:uint [только для чтения]

Версии среды выполнения:

AIR 1.0

Возвращает число байтов данных, доступных для чтения во входном буфере. В коде должен быть вызов свойства bytesAvailable, проверяющий доступность необходимого объема данных до того, как будет выполнена попытка их считывания с помощью одного из методов чтения.

Реализация
public function get bytesAvailable():uint

endian

свойство

endian:String

Версии среды выполнения:

AIR 1.0

Порядок байтов данных, константа BIG_ENDIAN или LITTLE_ENDIAN класса Endian.

Реализация
public function get endian():String
public function set endian(value:String):void

objectEncoding

свойство

objectEncoding:uint

Версии среды выполнения:

AIR 1.0

Указывает, какой формат, AMF3 или AMF0, используется для записи или чтения бинарных данных методом readObject() или writeObject().

Значение представлено константой из класса ObjectEncoding. По умолчанию используется формат AMF3.

Реализация
public function get objectEncoding():uint
public function set objectEncoding(value:uint):void

Связанные элементы API

ObjectEncoding
readObject()
writeObject()

position

свойство

position:Number

Версии среды выполнения:

AIR 1.0

Текущее положение в файле.

Данное значение изменяется при следующих условиях:

Если явно задано свойство.
Если производится считывание из объекта FileStream (с использованием одного из методов чтения).
Если производится запись в объект FileStream.

Положение определяется как Number (а не uint) для поддержки файлов длиной более 2³² байтов. Значение данного свойства всегда представлено целым числом до 2⁵³. Если задать это значение дробным числом, то оно будет округлено до целого в меньшую сторону.

Если при асинхронном чтении файла задать свойство position, приложение начнет заполнять буфер чтения данными, начиная с указанного положения, а свойство bytesAvailable может принять значение 0. Дождитесь события complete, прежде чем использовать метод read для чтения данных или дождитесь события progress и проверьте свойство bytesAvailable, прежде чем использовать метод read.

Реализация
public function get position():Number
public function set position(value:Number):void

Пример ( Использование этого примера )

На примере следующего кода показано, как обновляется свойство position объекта FileStream по мере считывания приложением данных из файла.

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

readAhead

свойство

readAhead:Number

Версии среды выполнения:

AIR 1.0

Минимальный объем данных, читаемых с диска в асинхронном режиме.

Это свойство указывает, сколько данных пытается считать асинхронный поток за точкой текущего положения. Данные считываются блоками на основе размера страницы файловой системы. Поэтому, если для readAhead установлено значение 9000 в компьютерной системе с размером страницы 8 КБ (8192 байт), среда выполнения одновременно считывает следующие 2 блока или 16384 байт данных. Значение этого свойства по умолчанию — бесконечность: по умолчанию из файла, открытого для асинхронного чтения, данные считываются, пока не будет достигнут конец файла.

Считывание данных из буфера чтения не влияет на значение свойства readAhead. При считывании данных из буфера новые данные считываются в буфер для его пополнения.

Свойство readAhead не влияет на файл, открытый в синхронном режиме.

При считывании данных в асинхронном режиме объект FileStream отправляет события progress. В методе обработчика событий для события progress проверьте доступность необходимого количества байтов (это можно проверить с помощью свойства bytesAvailable), а затем считайте данные из буфера чтения с помощью метода read.

Реализация
public function get readAhead():Number
public function set readAhead(value:Number):void

Пример ( Использование этого примера )

На примере следующего кода показано, как с помощью свойства readAhead ограничить объем данных, считываемых в файл, до 100 байтов:

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

Сведения о конструкторе

()

Конструктор

public function FileStream()

Версии среды выполнения:

AIR 1.0

Создает объект FileStream. Для открытия файла используйте методы open() или openAsync().

Связанные элементы API

open()
openAsync()

Сведения о методе

close

()

метод

public function close():void

Версии среды выполнения:

AIR 1.0

Закрывает объект FileStream.

После вызова метода close() данные невозможно считывать или записывать. Если файл был открыт в асинхронном режиме (объект FileStream использует для открытия файла метод openAsync()), вызов метода close() заставляет объект вызвать событие close.

Автоматическое закрытие приложения закрывает все файлы, связанные с объектами FileStream в приложении. Тем не менее, рекомендуется ставить все асинхронно открытые объекты FileStream, у которых есть данные, ожидающие записи, в очередь на событие closed, прежде чем закрывать приложение (чтобы данные точно были записаны).

Можно повторно использовать объект FileStream, вызвав метод open() или openAsync(). Все файлы, связанные с объектом FileStream, при этом закрываются, но объект не вызывает событие close.

Что касается объекта FileStream, открытого в асинхронном режиме (с использованием метода openAsync()), то даже если вызвать событие close() для этого объекта и удалить свойства и переменные, ссылающиеся на него, объект FileStream не будет удален из памяти до тех пор, пока в остаются невыполненные операции и обработчики событий, ждущие их выполнения. В частности, объект FileStream, на который нет других ссылок, будет существовать, пока выполняется хотя бы одно из следующих условий:

При выполнении считывания из файла не был достигнут конец файла (и не было вызвано событие complete).
Выходные данные будут по-прежнему доступны для записи, а у связанных с ними событий (таких как outputProgress или ioError) будут прослушиватели событий.

События

close:Event — Открытый в асинхронном режиме файл будет закрыт.

Связанные элементы API

open()
Событие close

Пример ( Использование этого примера )

Следующий код открывает объект FileStream асинхронно и записывает текстовый файл с именем test.txt во вложенный каталог Apollo Test каталога документов пользователя. Вызов метода close() объекта FileStream закрывает файл после записи данных.

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

Следующий код открывает объект FileStream синхронно и записывает текстовый файл с именем test.txt во вложенный каталог Apollo Test каталога документов пользователя. Вызов метода close() объекта FileStream закрывает файл после записи данных.

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

open

()

метод

public function open(file:File, fileMode:String):void

Версии среды выполнения:

AIR 1.0

Открывает объект FileStream в синхронном режиме, указывая на файл, заданный параметром file.

Если объект FileStream уже открыт, вызов метода закрывает файл перед открытием, и последующие события (включая close) не передаются ранее открытому файлу.

В системах, поддерживающих блокирование файлов, файлы, открытые только для записи или только для обновления (FileMode.WRITE или FileMode.UPDATE), недоступны для чтения, пока они не будут закрыты.

После завершения выполнения операций с файлом необходимо вызвать метод close() объекта FileStream. В некоторых системах число одновременно открытых файлов ограничено.

Параметры

	`file:File` — Объект File, указывающий на файл, который необходимо открыть.

	`fileMode:String` — Строка класса FileMode, определяющая доступные действия объекта FileStream, например чтение или запись в файл.

Выдает

	`IOError` — Файла не существует; у вас нет прав для открытия файла; вы открываете файл для чтения, но у вас нет прав на чтение; вы открываете файл для записи, но у вас нет прав для записи.

	`SecurityError` — Файл находится в каталоге приложения, и для параметра `fileMode` задан режим append, update или write.

Связанные элементы API

close()
Файл
FileMode

Пример ( Использование этого примера )

Следующий код показывает, как синхронно открыть файл test.txt во вложенном каталоге Apollo Test каталога документов пользователя, а затем считать этот файл в строку, используя для кодировки текста системный набор символов.

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

openAsync

()

метод

public function openAsync(file:File, fileMode:String):void

Версии среды выполнения:

AIR 1.0

Открывает объект FileStream в асинхронном режиме, указывая на файл, заданный параметром file.

Если параметру fileMode присвоена константа FileMode.READ или FileMode.UPDATE, AIR считывает данные во входной буфер при открытии файла, а события progress и open отправляются по мере считывания данных во входной буфер.

Параметры

	`file:File` — Объект File, указывающий на файл, который необходимо открыть.

	`fileMode:String` — Строка класса FileMode, определяющая доступные действия объекта FileStream, например чтение или запись в файл.

События

	`ioError:IOErrorEvent` — Файла не существует; у вас нет прав для открытия файла; вы открываете файл для чтения, но у вас нет прав на чтение; вы открываете файл для записи, но у вас нет прав для записи.

	`progress:ProgressEvent` — Вызывается при считывании данных во входной буфер. (При открытии файла для параметра `fileMode` должно быть установлено значение `FileMode.READ` или `FileMode.UPDATE`.)

	`complete:Event` — Данные файла считаны во входной буфер. (При открытии файла для параметра `fileMode` должно быть установлено значение `FileMode.READ` или `FileMode.UPDATE`.)

Выдает

SecurityError — Файл находится в каталоге приложения, и для параметра fileMode задан режим append, update или write.

Связанные элементы API

close()
Событие complete
Событие ioError
Событие progress
FileMode

Пример ( Использование этого примера )

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

readBoolean

()

метод

public function readBoolean():Boolean

Версии среды выполнения:

AIR 1.0

Считывает логическое значение из потока файлов, байтов или массива байтов. Считывается один байт. Если этот байт ненулевой, то возвращается значение true. В противном случае возвращается значение false.

Возвращает

Boolean — Логическое значение будет true, если количество байтов не равно нулю, в остальных случаях оно будет false.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readByte

()

метод

public function readByte():int

Версии среды выполнения:

AIR 1.0

Считывает байт со знаком из потока файлов, байтов или массива байтов.

Возвращает

int — Возвращенное значение находится в диапазоне от -128 до 127.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readBytes

()

метод

public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void

Версии среды выполнения:

AIR 1.0

Считывает число байтов данных, заданное параметром length, из потока файлов, байтов или массива байтов. Байты считываются в объект ByteArray, определяемый параметром bytes, при этом начальная позиция определяется параметром offset.

Параметры

	`bytes:ByteArray` — Объект `ByteArray`, в который считываются данные.

	`offset:uint` (default = `0`) — Смещение в параметре `bytes`, с которого должно начинаться считывание данных.

	`length:uint` (default = `0`) — Число байтов для считывания. Если значение по умолчанию равно 0, считываются все доступные данные.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readDouble

()

метод

public function readDouble():Number

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов число IEEE 754 с двойной точностью и плавающей запятой.

Возвращает

Number — Число IEEE 754 с двойной точностью и плавающей запятой.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readFloat

()

метод

public function readFloat():Number

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов число IEEE 754 с одинарной точностью и плавающей запятой.

Возвращает

Number — Число IEEE 754 с одинарной точностью и плавающей запятой.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readInt

()

метод

public function readInt():int

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов 32-разрядное целое число со знаком.

Возвращает

int — Возвращаемое значение находится в диапазоне от -2147483648 до 2147483647.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readMultiByte

()

метод

public function readMultiByte(length:uint, charSet:String):String

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов многобайтовую строку заданной длины с использованием указанного набора символов.

Параметры

	`length:uint` — Число считываемых из потока байтов.

	`charSet:String` — Строка, обозначающая набор символов, которые используются для интерпретации байтов. Возможные строки наборов символов: `"shift_jis"`, `"cn-gb"`, `"iso-8859-1"` и другие. Полный список см. в разделе Поддерживаемые наборы символов. Примечание. Если в текущей системе не распознается значение параметра `charSet`, то в качестве набора символов Adobe^® Flash^® Player или Adobe^® AIR^® будет использована кодовая страница по умолчанию. Например, значение параметра `charSet`, как в `myTest.readMultiByte(22, iso-8859-01)`, использующее `01` вместо `1`, может работать в системе разработчика, а в другой системе нет. В другой системе программа Flash Player или среда выполнения AIR будет использовать кодовую страницу, заданную по умолчанию в системе.

Возвращает

String — Строка в кодировке UTF-8.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

Связанные элементы API

File.systemCharset

readObject

()

метод

public function readObject():*

Версии среды выполнения:

AIR 1.0

Считывает объект из потока файлов, байтов или массива байтов зашифрованный в сериализованном формате AMF.

Возвращает

* — Десериализованный объект

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

Связанные элементы API

flash.net.registerClassAlias()

readShort

()

метод

public function readShort():int

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов 16-разрядное целое число со знаком.

Возвращает

int — Возвращаемое значение находится в диапазоне от -32768 до 32767.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readUnsignedByte

()

метод

public function readUnsignedByte():uint

Версии среды выполнения:

AIR 1.0

Считывает байт без знака из потока файлов, байтов или массива байтов.

Возвращает

uint — Возвращенное значение находится в диапазоне от 0 до 255.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readUnsignedInt

()

метод

public function readUnsignedInt():uint

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов 32-разрядное целое число без знака.

Возвращает

uint — Возвращенное значение находится в диапазоне от 0 до 4294967295.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readUnsignedShort

()

метод

public function readUnsignedShort():uint

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов 16-разрядное целое число без знака.

Возвращает

uint — Возвращенное значение находится в диапазоне от 0 до 65535.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readUTF

()

метод

public function readUTF():String

Версии среды выполнения:

AIR 1.0

Считывает из потока файлов, байтов или массива байтов строку UTF-8. Предполагается, что в строку вставляется префикс с неподписанным значением, указывающим длину в байтах.

Этот метод похож на метод readUTF() в интерфейсе Java^® IDataInput.

Возвращает

String — Строка в кодировке UTF-8, являющаяся байтовым представлением символов.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

readUTFBytes

()

метод

public function readUTFBytes(length:uint):String

Версии среды выполнения:

AIR 1.0

Считывает последовательность байтов UTF-8 из потока байтов или массива байтов и возвращает строку.

Параметры

length:uint — Число байтов для считывания.

Возвращает

String — Строка в кодировке UTF-8, являющаяся байтовым представлением символов указанной длины.

События

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

truncate

()

метод

public function truncate():void

Версии среды выполнения:

AIR 1.0

Сокращает файл до положения, заданного свойством position объекта FileStream.

Все байты от положения, заданного свойством position, до конца файла, удаляются. Файл должен быть открыт для записи.

Выдает

IllegalOperationError — Файл не открыт для записи.

Связанные элементы API

position

Пример ( Использование этого примера )

Следующий код синхронно открывает файл test.txt во вложенном каталоге Apollo Test каталога документов пользователя, а затем обрезает этот файл до 100 символов, если его длина превышает 100 символов.

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

Следующий код асинхронно открывает файл test.txt во вложенном каталоге Apollo Test каталога документов пользователя, а затем обрезает этот файл до 100 символов, если его длина превышает 100 символов.

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

writeBoolean

()

метод

public function writeBoolean(value:Boolean):void

Версии среды выполнения:

AIR 1.0

Записывает логическое значение. Записывается один байт, соответствующий параметру value, 1 в случае значения true и 0 в случае значения false.

Параметры

value:Boolean — Логическое значение, показывающее, какой байт записывается. Если параметр имеет значение true, записывается 1; если false, записывается 0.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

writeByte

()

метод

public function writeByte(value:int):void

Версии среды выполнения:

AIR 1.0

Записывает байт. Используются 8 младших битов параметра, а 24 старших битов игнорируются.

Параметры

value:int — Значение байта в виде целого числа.

События

Выдает

writeBytes

()

метод

public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void

Версии среды выполнения:

AIR 1.0

Записывает последовательность байтов из заданного массива байтов bytes, начиная с байта, заданного параметром offset (используя индекс с нулевой базой), длиной, заданной параметром length, в поток файлов, байтов или массив байтов.

Если параметр length опущен, применение длины по умолчанию, равной 0, приведет к тому, что будет записан весь буфер, начиная со значения параметра offset. Если также опустить параметр offset, будет записываться весь буфер.

Если параметры offset или length находятся за пределами диапазона, то они корректируются так, чтобы совпасть с началом и концом массива bytes.

Параметры

	`bytes:ByteArray` — Массив байтов для записи.

	`offset:uint` (default = `0`) — Индекс с нулевой базой, определяющий положение в массиве для начала записи.

	`length:uint` (default = `0`) — Целое число без знака, определяющее глубину буфера для записи.

События

Выдает

writeDouble

()

метод

public function writeDouble(value:Number):void

Версии среды выполнения:

AIR 1.0

Записывает число IEEE 754 с двойной точностью (64-разрядное) и плавающей запятой.

Параметры

value:Number — Число с двойной точностью (64-разрядное) и плавающей запятой.

События

Выдает

writeFloat

()

метод

public function writeFloat(value:Number):void

Версии среды выполнения:

AIR 1.0

Записывает число IEEE 754 с одинарной точностью (32-разрядное) и плавающей запятой.

Параметры

value:Number — Число с одинарной точностью (32-разрядное) и плавающей запятой.

События

Выдает

writeInt

()

метод

public function writeInt(value:int):void

Версии среды выполнения:

AIR 1.0

Записывает 32-разрядное целое число со знаком.

Параметры

value:int — Значение байта в виде целого числа со знаком.

События

Выдает

writeMultiByte

()

метод

public function writeMultiByte(value:String, charSet:String):void

Версии среды выполнения:

AIR 1.0

Записывает в поток файлов, байтов или массив байтов многобайтовую строку заданной длины с использованием заданного набора символов.

Параметры

	`value:String` — Записываемое значение строки.

	`charSet:String` — Строка, определяющая используемый набор символов. Возможные строки наборов символов: `"shift_jis"`, `"cn-gb"`, `"iso-8859-1"` и другие. Полный список см. в разделе Поддерживаемые наборы символов.

События

Выдает

Связанные элементы API

File.systemCharset

writeObject

()

метод

public function writeObject(object:*):void

Версии среды выполнения:

AIR 1.0

Записывает объект в поток файлов, байтов или массив байтов в сериализованном формате AMF.

Параметры

object:* — Объект для сериализации.

События

Выдает

Связанные элементы API

flash.net.registerClassAlias()

writeShort

()

метод

public function writeShort(value:int):void

Версии среды выполнения:

AIR 1.0

Записывает 16-разрядное целое число. Используются 16 младших битов параметра, а 16 старших битов игнорируются.

Параметры

value:int — Значение байта в виде целого числа.

События

Выдает

writeUnsignedInt

()

метод

public function writeUnsignedInt(value:uint):void

Версии среды выполнения:

AIR 1.0

Записывает 32-разрядное целое число без знака.

Параметры

value:uint — Значение байта в виде целого числа без знака.

События

Выдает

writeUTF

()

метод

public function writeUTF(value:String):void

Версии среды выполнения:

AIR 1.0

Записывает в поток файлов, байтов или массив байтов строку UTF-8. Сначала записывается длина строки UTF-8 в байтах (в виде 16-разрядного целого числа), за которой следуют байты символов строки.

Параметры

value:String — Записываемое значение строки.

События

Выдает

	`RangeError` — Если длина строки превышает 65535.

	`IOError` — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), в файл не может быть произведена запись (например, из-за отсутствия файла).

writeUTFBytes

()

метод

public function writeUTFBytes(value:String):void

Версии среды выполнения:

AIR 1.0

Записывает строку UTF-8. Аналогично writeUTF(), но строке не предшествует 16-разрядное слово, указывающее длину.

Параметры

value:String — Записываемое значение строки.

События

Выдает

Сведения о событии

close

Событие

Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.CLOSE

Версии среды выполнения:

AIR 1.0

Указывает, что поток был закрыт формальным вызовом метода close().

Константа Event.CLOSE определяет значение свойства type объекта события close.

Это событие имеет следующие свойства:

Свойство	Значение
`bubbles`	`false`
`cancelable`	`false`; поведение по умолчанию, подлежащее отмене, не определено.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Объект, для которого разорвано подключение.

Связанные элементы API

close()

complete

Событие

Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.COMPLETE

Версии среды выполнения:

AIR 1.0

Сообщает о достижении конца потока.

Константа Event.COMPLETE определяет значение свойства type объекта complete.

Это событие имеет следующие свойства:

Свойство	Значение
`bubbles`	`false`
`cancelable`	`false`; поведение по умолчанию, подлежащее отмене, не определено.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Сетевой объект, который завершил загрузку.

Связанные элементы API

position

ioError

Событие

Тип объекта события: flash.events.IOErrorEvent
свойство IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Версии среды выполнения:

AIR 1.0

Указывает, что во время выполнения асинхронной операции ввода-вывода произошла ошибка.

Задает значение свойства type для объекта события ioError.

Это событие имеет следующие свойства:

Свойство	Значение
`bubbles`	`false`
`cancelable`	`false`; поведение по умолчанию, подлежащее отмене, не определено.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`errorID`	Ссылочный номер, связываемый с конкретной ошибкой (только AIR).
`target`	Сетевой объект, с которым произошла ошибка ввода/вывода.
`text`	Текст, отображаемый в качестве сообщения об ошибке.

outputProgress

Событие

Тип объекта события: flash.events.OutputProgressEvent
свойство OutputProgressEvent.type = flash.events.OutputProgressEvent.OUTPUT_PROGRESS

Версии среды выполнения:

AIR 1.0

Сообщает, что запись данных из буфера в файл завершена.

Задает значение свойства type для объекта события outputProgress.

Это событие имеет следующие свойства:

Свойство	Значение
`bubbles`	`false`
`bytesPending`	Число байт, которые остается записать на момент обработки события прослушивателем.
`bytesTotal`	Общее число элементов или байт, которые в итоге будут записаны в случае успешного завершения записи.
`cancelable`	`false`; поведение по умолчанию, подлежащее отмене, не определено.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Объект FileStream, сообщающий сведения о прогрессе.

progress

Событие

Тип объекта события: flash.events.ProgressEvent
свойство ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Версии среды выполнения:

AIR 1.0

Сообщает, что в потоке появились новые доступные данные.

Задает значение свойства type для объекта события progress.

Это событие имеет следующие свойства:

Свойство	Значение
`bubbles`	`false`
`bytesLoaded`	Число элементов или байтов, загруженных на момент обработки события прослушивателем.
`bytesTotal`	Общее число элементов или байтов, которые в итоге будут получены в случае успешного завершения загрузки.
`cancelable`	`false`; поведение по умолчанию, подлежащее отмене, не определено.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Объект, сообщающий сведения о прогрессе.

Юридическая информация | Политика конфиденциальности онлайн

FileStream - AS3

Классы x

bytesAvailable

endian

objectEncoding

position

readAhead

FileStream

close

open

openAsync

readBoolean

readByte

readBytes

readDouble

readFloat

readInt

readMultiByte

readObject

readShort

readUnsignedByte

readUnsignedInt

readUnsignedShort

readUTF

readUTFBytes

truncate

writeBoolean

writeByte

writeBytes

writeDouble

writeFloat

writeInt

writeMultiByte

writeObject

writeShort

writeUnsignedInt

writeUTF

writeUTFBytes

close

complete

ioError

outputProgress

progress