Вспоминаем

Вспоминаем материал, изложенный в предыдущей статье, у нас на очереди запись в файл, сохранение файлов, создание Blob-ов.

Опять приведу список всех классов FileAPI и FileSystemAPI:

• Blob - сущность, позволяющая разбирать файл по байтам. От Blob наследуется класс File.
• File - сам файл.
• FileList - список (массив) файлов.
• FileReader - класс для чтения файла.
• FileReaderSync - синхронный класс для чтения файла.
• FileWriter - класс для записи в файл.
• FileWriterSync - синхронный класс для записи в файл.
• BlobBuilder - создание Blob.
• FileSaver - сохранение файлов к пользователю (через окошко Save as...).
• FileSaverSync - синхронное сохранение файлов к пользователю.
• FileEntry - файловые операции.
• DirectoryReader - "чтение" (а именно получение всех файлов) директории/папки.
• DirectoryEntry - файловые операции.
• LocalFileSystem - локальное хранилище файлов.
• LocalFileSystemSync - синхронное локальное хранилище файлов.
• FileError - класс ошибки.
• FileException - класс исключений (try...catch).

Серым курсивом выделены классы, которые мы прошли в предыдущей статье. Как видим, нам осталась довольно много. Но не расстраиваемся, у нас ещё три статьи (включая эту). Поехали*.

FileWriter

Класс FileWriter позволяет нам записывать что-либо в файл. Наследуется он от класса FileSaver (о нём чуть дальше). Как написано в спецификации, FileWriter предназначен только для работы с изолированной файловой системой (класс LocalFileSystem). Есть след. свойства и методы:

• position^number - смещение, по которому будут записывать байты (должно быть больше длины файла).
• length^number - длина всего файла.
• readyState^number - состояние записи (наслед. от FileSaver).
• error^FileError - в случае наступления ошибки содержит ошибку (наслед. от FileSaver).
• abort() - отменяет запись в файл (наслед. от FileSaver).
• write(data) - записывает данные из data (data должен иметь тип Blob) в текущую позицию (свойство position).
• seek(offset) - устанавливает текущую позицию (параметр position).
• truncate(size) - расширяет файл (увеличивает размер). Если увеличиваем, то все новые байты заполняются нулями. Уменьшаем - байты обрезаются.

Продолжим. Теперь поподробнее про свойство readyState. Оно содержит одну из след. констант:

• FileWriter.INIT=0 - инициализирован, но не готов для записи.
• FileWriter.WRITING=1 - пишется.
• FileWriter.DONE=2 - успешно записан/выпала ошибка/прервано методом abort().

Также есть события записи. Смотрим:

• onwritestart - запись началась.
• onprogress - постоянно при записи.
• onwrite - при успешном окончании записи.
• onabort - при отмене методом abort().
• onerror - при возникновении ошибки.
• onwriteend - при окончании записи (в том числе неуспешном, возникает после onwrite, onabort, либо onerror).

Всё это наследуется от класса FileSaver. Посмотрим класс FileWriterSync, он НЕ наследуется от FileSaver.

FileWriterSync

Класс FileWriterSync предпологает синхронную запись в файл. Посмотрим на методы и свойства, которых здесь гораздо меньше:

• position^number - смещение, по которому будут записывать байты (должно быть больше длины файла).
• length^number - длина всего файла.
• write(data) - записывает данные из data (data должен иметь тип Blob) в текущую позицию (свойство position).
• seek(offset) - устанавливает текущую позицию (параметр position).
• truncate(size) - расширяет файл (увеличивает размер). Если увеличиваем, то все новые байты заполняются нулями. Уменьшаем - байты обрезаются.

И всё. Даже событий нету.

BlobBuilder

Класс BlobBuilder позволяет нам создавать новые Blob-ы.

Теперь методы (свойств нету):

• getBlob([contentType]) - получаем Blob.
• append(text, [endings]) - добавляем в конец текст.
• append(data) - если data типа Blob, то байты из Blob-а вставляются в конец.
• append(data) - ещё можно указать тип ArrayBuffer.

FileSaver

Класс FileSaver позволяет нам отслеживать события сохранения страницы... Ладно, короче код:

Как вы уже наверняка догадались, метод saveAs сохраняет к пользователю новый файл, созданный из Blob, под именем test_file. И, как вы уже наверняка догадались, он возвращает объект класса FileSaver. Методы, события и пр. уже знакомо по FileWriter:

• abort() - отмена сохранения файла.
• readyState - состояние записи. Содержит одну из след. констант:
• FileSaver.INIT=0 - инициализирован, но запись не началась.
• FileSaver.WRITING=1 - записывается.
• FileSaver.DONE=2 - запись окончена (успешно записался, либо ошибка).
• error - в случае ошибки, содержит ошибку (FileError).

Ну и обработчики событий:

• onwritestart - начало записи.
• onprogress - каждую секунду при записи.
• onwrite - успешно записалось.
• onabort - отмена записи методом abort().
• onerror - ошибка.
• onwriteend - окончание записи (в том числе и неуспешное).

И что дальше?

В следующей статье мы наконец раскроем работу с локальным хранилищем файлов, работу с файлами и папками. Ну а затем у нас заключительная, где раскроются классы ошибок и исключений (FileError и FileException); а также - как всё это поддерживают браузеры.