diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /xpcom/io/nsIRandomAccessStream.idl | |
parent | Initial commit. (diff) | |
download | firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip |
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'xpcom/io/nsIRandomAccessStream.idl')
-rw-r--r-- | xpcom/io/nsIRandomAccessStream.idl | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/xpcom/io/nsIRandomAccessStream.idl b/xpcom/io/nsIRandomAccessStream.idl new file mode 100644 index 0000000000..20421def17 --- /dev/null +++ b/xpcom/io/nsIRandomAccessStream.idl @@ -0,0 +1,62 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* 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 "nsISupports.idl" +#include "nsISeekableStream.idl" + +interface nsIInputStream; +interface nsIInterfaceRequestor; +interface nsIOutputStream; + +%{C++ +namespace mozilla::ipc { +class RandomAccessStreamParams; +} // namespace mozilla::ipc +%} + +native RandomAccessStreamParams(mozilla::ipc::RandomAccessStreamParams); +[ref] native RandomAccessStreamParamsRef(mozilla::ipc::RandomAccessStreamParams); + +/** + * nsIRandomAccessStream + * + * An interface which supports both reading and writing to a storage starting + * at the current offset. Both the input stream and the output stream share the + * offset in the stream. Read operations invoked on the input stream start at + * the offset and advance it past the bytes read. Write operations invoked on + * the output stream start the offset and advance it past the bytes written. + * The offset can be set to an arbitrary value prior reading or writting. Each + * call to getInputStream or getOutputStream always returns the same object, + * rather than creating a new stream. It's recommended for objects implementing + * this interface to also implement nsIInputStream and nsIOutputStream, so they + * can be easilly used with e.g. NS_AsyncCopy. + */ +[scriptable, builtinclass, uuid(9b5904a8-886a-420f-a1d8-847de8ffc133)] +interface nsIRandomAccessStream : nsISeekableStream +{ + /** + * This method always returns the same object. + */ + nsIInputStream getInputStream(); + + /** + * This method always returns the same object. + */ + nsIOutputStream getOutputStream(); + + /** + * Like getInputStream but infallible. + */ + [notxpcom, nostdcall] nsIInputStream inputStream(); + + /** + * Like getOutputStream but infallible. + */ + [notxpcom, nostdcall] nsIOutputStream outputStream(); + + [notxpcom, nostdcall] RandomAccessStreamParams serialize(in nsIInterfaceRequestor aCallbacks); + + [notxpcom, nostdcall] bool deserialize(inout RandomAccessStreamParamsRef params); +}; |