blob: 3e084cbe7f64d3a829c1d509d0d0820a357137da (
plain)
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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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"
%{C++
#include "mozilla/MemoryReporting.h"
namespace mozilla {
class StreamBufferSource;
} // namespace mozilla
%}
native MallocSizeOf(mozilla::MallocSizeOf);
[ptr] native StreamBufferSource(mozilla::StreamBufferSource);
/**
* nsIStringInputStream
*
* Provides scriptable and specialized C++-only methods for initializing a
* nsIInputStream implementation with a simple character array.
*/
[scriptable, builtinclass, uuid(450cd2d4-f0fd-424d-b365-b1251f80fd53)]
interface nsIStringInputStream : nsIInputStream
{
/**
* SetData - assign data to the input stream (copied on assignment).
*
* @param data - stream data
* @param dataLen - stream data length (-1 if length should be computed)
*
* NOTE: C++ code should consider using AdoptData or ShareData to avoid
* making an extra copy of the stream data.
*
* NOTE: For JS callers, the given data must not contain null characters
* (other than a null terminator) because a null character in the middle of
* the data string will be seen as a terminator when the data is converted
* from a JS string to a C++ character array.
*/
void setData(in string data, in long dataLen);
/**
* SetUTF8Data - encode input data to UTF-8 and assign it to the input
* stream.
*
* @param data - stream data
*
* NOTE: This method is meant to be used by JS callers,
*/
void setUTF8Data(in AUTF8String data);
/**
* NOTE: the following methods are designed to give C++ code added control
* over the ownership and lifetime of the stream data. Use with care :-)
*/
/**
* AdoptData - assign data to the input stream. the input stream takes
* ownership of the given data buffer and will free it when
* the input stream is destroyed.
*
* @param data - stream data
* @param dataLen - stream data length (-1 if length should be computed)
*/
[noscript] void adoptData(in charPtr data, in long dataLen);
/**
* ShareData - assign data to the input stream. the input stream references
* the given data buffer until the input stream is destroyed. the given
* data buffer must outlive the input stream.
*
* @param data - stream data
* @param dataLen - stream data length (-1 if length should be computed)
*/
[noscript] void shareData(in string data, in long dataLen);
/**
* SetDataSource - assign data to the input stream. the input stream holds
* a strong reference to the given data buffer until it is destroyed.
*
* @param source - stream data source
*/
[noscript] void setDataSource(in StreamBufferSource source);
[noscript, notxpcom]
size_t SizeOfIncludingThisIfUnshared(in MallocSizeOf aMallocSizeOf);
[noscript, notxpcom]
size_t SizeOfIncludingThisEvenIfShared(in MallocSizeOf aMallocSizeOf);
};
|
