mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 06:05:44 +00:00
80 lines
2.9 KiB
Plaintext
80 lines
2.9 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
|
*
|
|
* 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.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
#include "nsIInputStream.idl"
|
|
|
|
interface nsIBuffer;
|
|
|
|
%{C++
|
|
/**
|
|
* The signature of the writer function passed to ReadSegments. This
|
|
* specifies where the data should go that gets read from the buffer.
|
|
* Implementers should return the following:
|
|
* @return NS_OK and writeCount - if successfully wrote something
|
|
* @return NS_BASE_STREAM_CLOSED - if no more can be written
|
|
* @return NS_BASE_STREAM_WOULD_BLOCK - if there is currently space to write (in
|
|
* a non-blocking mode)
|
|
* @return <other-error> - on failure
|
|
*/
|
|
typedef NS_CALLBACK(nsWriteSegmentFun)(void* closure,
|
|
const char* fromRawSegment,
|
|
PRUint32 toOffset,
|
|
PRUint32 count,
|
|
PRUint32 *writeCount);
|
|
%}
|
|
|
|
native nsWriteSegmentFun(nsWriteSegmentFun);
|
|
|
|
[scriptable, uuid(93e9a230-1955-11d3-933b-000064657374)]
|
|
interface nsIBufferInputStream : nsIInputStream
|
|
{
|
|
/**
|
|
* Returns the buffer underlying this input stream.
|
|
*/
|
|
readonly attribute nsIBuffer Buffer;
|
|
|
|
|
|
[noscript] unsigned long ReadSegments(in nsWriteSegmentFun writer,
|
|
in voidStar closure,
|
|
in unsigned long count);
|
|
|
|
/**
|
|
* Searches for a string in the input stream. Since the stream has a notion
|
|
* of EOF, it is possible that the string may at some time be in the
|
|
* buffer, but is is not currently found up to some offset. Consequently,
|
|
* both the found and not found cases return an offset:
|
|
* if found, return offset where it was found
|
|
* if not found, return offset of the first byte not searched
|
|
* In the case the stream is at EOF and the string is not found, the first
|
|
* byte not searched will correspond to the length of the buffer.
|
|
*/
|
|
void Search(in string forString,
|
|
in boolean ignoreCase,
|
|
out boolean found,
|
|
out unsigned long offsetSearchedTo);
|
|
|
|
/**
|
|
* Set this attribute to put the stream in non-blocking mode.
|
|
*/
|
|
attribute boolean NonBlocking;
|
|
};
|