xpcom/io/nsIIOUtil.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIInputStream;
   9 interface nsIOutputStream;
  10
  11 /**
  12  * nsIIOUtil provdes various xpcom/io-related utility methods.
  13  */
  14 [scriptable, builtinclass, uuid(e8152f7f-4209-4c63-ad23-c3d2aa0c5a49)]
  15 interface nsIIOUtil : nsISupports
  16 {
  17   /**
  18    * Test whether an input stream is buffered.  See nsStreamUtils.h
  19    * documentation for NS_InputStreamIsBuffered for the definition of
  20    * "buffered" used here and for edge-case behavior.
  21    *
  22    * @throws NS_ERROR_INVALID_POINTER if null is passed in.
  23    */
  24   boolean inputStreamIsBuffered(in nsIInputStream aStream);
  25
  26   /**
  27    * Test whether an output stream is buffered.  See nsStreamUtils.h
  28    * documentation for NS_OutputStreamIsBuffered for the definition of
  29    * "buffered" used here and for edge-case behavior.
  30    *
  31    * @throws NS_ERROR_INVALID_POINTER if null is passed in.
  32    */
  33   boolean outputStreamIsBuffered(in nsIOutputStream aStream);
  34 };