chromium/third_party/blink/renderer/modules/filesystem/file_writer.idl

/*
 * Copyright (C) 2010 Google Inc.  All rights reserved.
 * Copyright (C) 2011 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// https://www.w3.org/TR/2012/WD-file-writer-api-20120417/#idl-def-FileWriter
[
  ActiveScriptWrappable,
  LegacyNoInterfaceObject
] interface FileWriter : EventTarget {
  // ready states
  const unsigned short INIT = 0;
  const unsigned short WRITING = 1;
  const unsigned short DONE = 2;
  [ImplementedAs=getReadyState] readonly attribute unsigned short readyState;

  // async write/modify methods
  [MeasureAs=DeprecatedFileSystemWrite, RaisesException]
  void write(Blob data);

  [RaisesException] void seek(long long position);

  [MeasureAs=DeprecatedFileSystemWrite, RaisesException]
  void truncate(long long size);

  [RaisesException] void abort();

  readonly attribute DOMException? error;
  readonly attribute long long position;
  readonly attribute long long length;

  attribute EventHandler onwritestart;
  attribute EventHandler onprogress;
  attribute EventHandler onwrite;
  attribute EventHandler onabort;
  attribute EventHandler onerror;
  attribute EventHandler onwriteend;
};