xpcom/io/nsIScriptableInputStream.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code, released
  16  * March 31, 1998.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1998-1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIInputStream;
  42
  43 /**
  44  * nsIScriptableInputStream provides scriptable access to an nsIInputStream
  45  * instance.
  46  */
  47 [scriptable, uuid(e546afd6-1248-4deb-8940-4b000b618a58)]
  48 interface nsIScriptableInputStream : nsISupports
  49 {
  50     /**
  51      * Closes the stream.
  52      */
  53     void close();
  54
  55     /**
  56      * Wrap the given nsIInputStream with this nsIScriptableInputStream.
  57      *
  58      * @param aInputStream parameter providing the stream to wrap
  59      */
  60     void init(in nsIInputStream aInputStream);
  61
  62     /**
  63      * Return the number of bytes currently available in the stream
  64      *
  65      * @return the number of bytes
  66      *
  67      * @throws NS_BASE_STREAM_CLOSED if called after the stream has been closed
  68      */
  69     unsigned long available();
  70
  71     /**
  72      * Read data from the stream.
  73      *
  74      * WARNING: If the data contains a null byte, then this method will return
  75      * a truncated string.
  76      *
  77      * @param aCount the maximum number of bytes to read
  78      *
  79      * @return the data, which will be an empty string if the stream is at EOF.
  80      *
  81      * @throws NS_BASE_STREAM_CLOSED if called after the stream has been closed
  82      * @throws NS_ERROR_NOT_INITIALIZED if init was not called
  83      */
  84     string read(in unsigned long aCount);
  85
  86     /**
  87      * Read data from the stream, including NULL bytes.
  88      *
  89      * @param aCount the maximum number of bytes to read.
  90      *
  91      * @return the data from the stream, which will be an empty string if EOF
  92      *         has been reached.
  93      *
  94      * @throws NS_BASE_STREAM_WOULD_BLOCK if reading from the input stream
  95      *         would block the calling thread (non-blocking mode only).
  96      * @throws NS_ERROR_FAILURE if there are not enough bytes available to read
  97      *         aCount amount of data.
  98      */
  99     ACString readBytes(in unsigned long aCount);
 100 };