1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* -*- Mode: C++; tab-width: 4; 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 "nsIInputStream.idl"
/**
* This interface allows consumption of primitive data types from a "binary
* stream" containing untagged, big-endian binary data, i.e. as produced by an
* implementation of nsIBinaryOutputStream. This might be used, for example,
* to implement network protocols or to read from architecture-neutral disk
* files, i.e. ones that can be read and written by both big-endian and
* little-endian platforms.
*
* @See nsIBinaryOutputStream
*/
[scriptable, builtinclass, uuid(899b826b-2eb3-469c-8b31-4c29f5d341a6)]
interface nsIBinaryInputStream : nsIInputStream {
void setInputStream(in nsIInputStream aInputStream);
/**
* Read 8-bits from the stream.
*
* @return that byte to be treated as a boolean.
*/
[must_use] boolean readBoolean();
[must_use] uint8_t read8();
[must_use] uint16_t read16();
[must_use] uint32_t read32();
[must_use] uint64_t read64();
[must_use] float readFloat();
[must_use] double readDouble();
/**
* Read an 8-bit pascal style string from the stream.
* 32-bit length field, followed by length 8-bit chars.
*/
[must_use] ACString readCString();
/**
* Read an 16-bit pascal style string from the stream.
* 32-bit length field, followed by length PRUnichars.
*/
[must_use] AString readString();
/**
* Read an opaque byte array from the stream.
*
* @param aLength the number of bytes that must be read.
*
* @throws NS_ERROR_FAILURE if it can't read aLength bytes
*/
[must_use] void readBytes(in uint32_t aLength,
[size_is(aLength), retval] out string aString);
/**
* Read an opaque byte array from the stream, storing the results
* as an array of PRUint8s.
*
* @param aLength the number of bytes that must be read.
*
* @throws NS_ERROR_FAILURE if it can't read aLength bytes
*/
[must_use] Array<uint8_t> readByteArray(in uint32_t aLength);
/**
* Read opaque bytes from the stream, storing the results in an ArrayBuffer.
*
* @param aLength the number of bytes that must be read
* @param aArrayBuffer the arraybuffer in which to store the results
* Note: passing view.buffer, where view is an ArrayBufferView of an
* ArrayBuffer, is not valid unless view.byteOffset == 0.
*
* @return The number of bytes actually read into aArrayBuffer.
*/
[implicit_jscontext, must_use]
uint64_t readArrayBuffer(in uint64_t aLength, in jsval aArrayBuffer);
};
%{C++
#ifdef MOZILLA_INTERNAL_API
#include "nsString.h"
inline nsresult
NS_ReadOptionalCString(nsIBinaryInputStream* aStream, nsACString& aResult)
{
bool nonnull;
nsresult rv = aStream->ReadBoolean(&nonnull);
if (NS_SUCCEEDED(rv)) {
if (nonnull)
rv = aStream->ReadCString(aResult);
else
aResult.Truncate();
}
return rv;
}
inline nsresult
NS_ReadOptionalString(nsIBinaryInputStream* aStream, nsAString& aResult)
{
bool nonnull;
nsresult rv = aStream->ReadBoolean(&nonnull);
if (NS_SUCCEEDED(rv)) {
if (nonnull)
rv = aStream->ReadString(aResult);
else
aResult.Truncate();
}
return rv;
}
#endif
%}
|
