Nika Layzell
9968df8fbe
This is a clean-up of previous changes to sliced input stream validation. This new approach should reduce the burdern on any external callers while maintaining the documented expected behaviour. It's OK for us to truncate these lengths, as start and length positions past the end of the provided stream have always been documented to be accepted, and this preserves the expected behaviour. Differential Revision: https://phabricator.services.mozilla.com/D293915
39 lines
1.8 KiB
Plaintext
39 lines
1.8 KiB
Plaintext
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsIInputStream.idl"
|
|
|
|
[scriptable, builtinclass, uuid(8149be1f-44d3-4f14-8b65-a57a5fbbeb97)]
|
|
interface nsICloneableInputStream : nsISupports
|
|
{
|
|
// Allow streams that implement the interface to determine if cloning
|
|
// possible at runtime. For example, this allows wrappers to check if
|
|
// their base stream supports cloning.
|
|
[infallible] readonly attribute boolean cloneable;
|
|
|
|
// Produce a copy of the current stream in the most efficient way possible.
|
|
// In this case "copy" means that both the original and cloned streams
|
|
// should produce the same bytes for all future reads. Bytes that have
|
|
// already been consumed from the original stream are not copied to the
|
|
// clone. Operations on the two streams should be completely independent
|
|
// after the clone() occurs.
|
|
nsIInputStream clone();
|
|
};
|
|
|
|
// This interface implements cloneWithRange() because for some streams
|
|
// (RemoteLazyInputStream only, so far) are more efficient to produce a sub
|
|
// stream with range than doing clone + SlicedInputStream().
|
|
[scriptable, builtinclass, uuid(ece853c3-aded-4cef-8f51-0d1493d60bd5)]
|
|
interface nsICloneableInputStreamWithRange : nsICloneableInputStream
|
|
{
|
|
// Create a copy of the input stream, but with the data range reduced to a
|
|
// sub-slice. The copy will begin at `start` bytes, and extends for a maximum
|
|
// of `length` bytes. If the underlying stream contains more than `start`
|
|
// bytes, but fewer than `length` bytes, reading from the stream returns all
|
|
// remaining bytes.
|
|
//
|
|
// See SlicedInputStream's constructor for more details.
|
|
nsIInputStream cloneWithRange(in uint64_t start, in uint64_t length);
|
|
};
|