• file
• revisions
• annotate
• diff
• comparison
• raw

xpcom/io/nsIIOUtil.idl@b8a032363ba2 (annotated)

xpcom/io/nsIIOUtil.idl

Thu, 22 Jan 2015 13:21:57 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Thu, 22 Jan 2015 13:21:57 +0100

branch

TOR_BUG_9701

changeset 15

b8a032363ba2

permissions

-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

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