Copy as Markdown
Other Tools
/*
* DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/xpcom/io/nsIOutputStream.idl
*/
#ifndef __gen_nsIOutputStream_h__
#define __gen_nsIOutputStream_h__
#include "nsISupports.h"
/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class nsIOutputStream; /* forward declaration */
class nsIInputStream; /* forward declaration */
/**
* The signature for the reader function passed to WriteSegments. This
* is the "provider" of data that gets written into the stream's buffer.
*
* @param aOutStream stream being written to
* @param aClosure opaque parameter passed to WriteSegments
* @param aToSegment pointer to memory owned by the output stream
* @param aFromOffset amount already written (since WriteSegments was called)
* @param aCount length of toSegment
* @param aReadCount number of bytes written
*
* Implementers should return the following:
*
* @throws <any-error> if not interested in providing any data
*
* Errors are never passed to the caller of WriteSegments.
*/
typedef nsresult (*nsReadSegmentFun)(nsIOutputStream *aOutStream,
void *aClosure,
char *aToSegment,
uint32_t aFromOffset,
uint32_t aCount,
uint32_t *aReadCount);
/* starting interface: nsIOutputStream */
#define NS_IOUTPUTSTREAM_IID_STR "0d0acd2a-61b4-11d4-9877-00c04fa0cf4a"
#define NS_IOUTPUTSTREAM_IID \
{0x0d0acd2a, 0x61b4, 0x11d4, \
{ 0x98, 0x77, 0x00, 0xc0, 0x4f, 0xa0, 0xcf, 0x4a }}
class NS_NO_VTABLE nsIOutputStream : public nsISupports {
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IOUTPUTSTREAM_IID)
/* Used by ToJSValue to check which scriptable interface is implemented. */
using ScriptableInterfaceType = nsIOutputStream;
/* void close (); */
NS_IMETHOD Close(void) = 0;
/* void flush (); */
NS_IMETHOD Flush(void) = 0;
/* void streamStatus (); */
NS_IMETHOD StreamStatus(void) = 0;
/* unsigned long write (in string aBuf, in unsigned long aCount); */
NS_IMETHOD Write(const char * aBuf, uint32_t aCount, uint32_t *_retval) = 0;
/* unsigned long writeFrom (in nsIInputStream aFromStream, in unsigned long aCount); */
NS_IMETHOD WriteFrom(nsIInputStream *aFromStream, uint32_t aCount, uint32_t *_retval) = 0;
/* [noscript] unsigned long writeSegments (in nsReadSegmentFun aReader, in voidPtr aClosure, in unsigned long aCount); */
NS_IMETHOD WriteSegments(nsReadSegmentFun aReader, void * aClosure, uint32_t aCount, uint32_t *_retval) = 0;
/* boolean isNonBlocking (); */
NS_IMETHOD IsNonBlocking(bool *_retval) = 0;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsIOutputStream, NS_IOUTPUTSTREAM_IID)
/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIOUTPUTSTREAM \
NS_IMETHOD Close(void) override; \
NS_IMETHOD Flush(void) override; \
NS_IMETHOD StreamStatus(void) override; \
NS_IMETHOD Write(const char * aBuf, uint32_t aCount, uint32_t *_retval) override; \
NS_IMETHOD WriteFrom(nsIInputStream *aFromStream, uint32_t aCount, uint32_t *_retval) override; \
NS_IMETHOD WriteSegments(nsReadSegmentFun aReader, void * aClosure, uint32_t aCount, uint32_t *_retval) override; \
NS_IMETHOD IsNonBlocking(bool *_retval) override;
/* Use this macro when declaring the members of this interface when the
class doesn't implement the interface. This is useful for forwarding. */
#define NS_DECL_NON_VIRTUAL_NSIOUTPUTSTREAM \
nsresult Close(void); \
nsresult Flush(void); \
nsresult StreamStatus(void); \
nsresult Write(const char * aBuf, uint32_t aCount, uint32_t *_retval); \
nsresult WriteFrom(nsIInputStream *aFromStream, uint32_t aCount, uint32_t *_retval); \
nsresult WriteSegments(nsReadSegmentFun aReader, void * aClosure, uint32_t aCount, uint32_t *_retval); \
nsresult IsNonBlocking(bool *_retval);
/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIOUTPUTSTREAM(_to) \
NS_IMETHOD Close(void) override { return _to Close(); } \
NS_IMETHOD Flush(void) override { return _to Flush(); } \
NS_IMETHOD StreamStatus(void) override { return _to StreamStatus(); } \
NS_IMETHOD Write(const char * aBuf, uint32_t aCount, uint32_t *_retval) override { return _to Write(aBuf, aCount, _retval); } \
NS_IMETHOD WriteFrom(nsIInputStream *aFromStream, uint32_t aCount, uint32_t *_retval) override { return _to WriteFrom(aFromStream, aCount, _retval); } \
NS_IMETHOD WriteSegments(nsReadSegmentFun aReader, void * aClosure, uint32_t aCount, uint32_t *_retval) override { return _to WriteSegments(aReader, aClosure, aCount, _retval); } \
NS_IMETHOD IsNonBlocking(bool *_retval) override { return _to IsNonBlocking(_retval); }
/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIOUTPUTSTREAM(_to) \
NS_IMETHOD Close(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Close(); } \
NS_IMETHOD Flush(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Flush(); } \
NS_IMETHOD StreamStatus(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->StreamStatus(); } \
NS_IMETHOD Write(const char * aBuf, uint32_t aCount, uint32_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Write(aBuf, aCount, _retval); } \
NS_IMETHOD WriteFrom(nsIInputStream *aFromStream, uint32_t aCount, uint32_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->WriteFrom(aFromStream, aCount, _retval); } \
NS_IMETHOD WriteSegments(nsReadSegmentFun aReader, void * aClosure, uint32_t aCount, uint32_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->WriteSegments(aReader, aClosure, aCount, _retval); } \
NS_IMETHOD IsNonBlocking(bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->IsNonBlocking(_retval); }
#endif /* __gen_nsIOutputStream_h__ */