| /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is Mozilla Communicator client code, released |
| * March 31, 1998. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corporation. |
| * Portions created by the Initial Developer are Copyright (C) 1998-1999 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either of the GNU General Public License Version 2 or later (the "GPL"), |
| * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| |
| interface nsIInputStream; |
| |
| /** |
| * nsIScriptableInputStream provides scriptable access to an nsIInputStream |
| * instance. |
| * |
| * @status FROZEN |
| */ |
| [scriptable, uuid(a2a32f90-9b90-11d3-a189-0050041caf44)] |
| interface nsIScriptableInputStream : nsISupports |
| { |
| /** |
| * Closes the stream. |
| */ |
| void close(); |
| |
| /** |
| * Wrap the given nsIInputStream with this nsIScriptableInputStream. |
| * |
| * @param aInputStream parameter providing the stream to wrap |
| */ |
| void init(in nsIInputStream aInputStream); |
| |
| /** |
| * Return the number of bytes currently available in the stream |
| * |
| * @return the number of bytes |
| * |
| * @throws NS_BASE_STREAM_CLOSED if called after the stream has been closed |
| */ |
| unsigned long available(); |
| |
| /** |
| * Read data from the stream. |
| * |
| * WARNING: If the data contains a null byte, then this method will return |
| * a truncated string. |
| * |
| * @param aCount the maximum number of bytes to read |
| * |
| * @return the data, which will be an empty string if the stream is at EOF. |
| * |
| * @throws NS_BASE_STREAM_CLOSED if called after the stream has been closed |
| * @throws NS_ERROR_NOT_INITIALIZED if init was not called |
| */ |
| string read(in unsigned long aCount); |
| }; |