xpcom/io/nsIStringStream.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsIInputStream.idl"
   7
   8 %{C++
   9 #include "mozilla/MemoryReporting.h"
  10
  11 namespace mozilla {
  12 class StreamBufferSource;
  13 }  // namespace mozilla
  14 %}
  15
  16 native MallocSizeOf(mozilla::MallocSizeOf);
  17 [ptr] native StreamBufferSource(mozilla::StreamBufferSource);
  18
  19 /**
  20  * nsIStringInputStream
  21  *
  22  * Provides scriptable and specialized C++-only methods for initializing a
  23  * nsIInputStream implementation with a simple character array.
  24  */
  25 [scriptable, builtinclass, uuid(450cd2d4-f0fd-424d-b365-b1251f80fd53)]
  26 interface nsIStringInputStream : nsIInputStream
  27 {
  28     /**
  29      * SetData - assign data to the input stream from a byte string.
  30      *
  31      * @param data    - stream data
  32      *
  33      * NOTE: For JS callers, no UTF-8 encoding will be performed.
  34      */
  35     void setByteStringData(in ACString data);
  36
  37     /**
  38      * SetUTF8Data - encode input data to UTF-8 and assign it to the input
  39      * stream.
  40      *
  41      * @param data    - stream data
  42      *
  43      * NOTE: This method is meant to be used by JS callers,
  44      */
  45     void setUTF8Data(in AUTF8String data);
  46
  47     /**
  48      * NOTE: the following methods are designed to give C++ code added control
  49      * over the ownership and lifetime of the stream data.  Use with care :-)
  50      */
  51
  52     /**
  53      * SetData - assign data to the input stream (copied on assignment).
  54      *
  55      * @param data    - stream data
  56      * @param dataLen - stream data length
  57      *
  58      * NOTE: C++ code should consider using AdoptData or ShareData to avoid
  59      * making an extra copy of the stream data.
  60      */
  61     [noscript] void copyData(in string data, in size_t dataLen);
  62
  63     /**
  64      * AdoptData - assign data to the input stream.  the input stream takes
  65      * ownership of the given data buffer and will free it when
  66      * the input stream is destroyed.
  67      *
  68      * @param data      - stream data
  69      * @param dataLen   - stream data length
  70      */
  71     [noscript] void adoptData(in charPtr data, in size_t dataLen);
  72
  73     /**
  74      * ShareData - assign data to the input stream.  the input stream references
  75      * the given data buffer until the input stream is destroyed.  the given
  76      * data buffer must outlive the input stream.
  77      *
  78      * @param data      - stream data
  79      * @param dataLen   - stream data length
  80      */
  81     [noscript] void shareData(in string data, in size_t dataLen);
  82
  83     /**
  84      * SetDataSource - assign data to the input stream.  the input stream holds
  85      * a strong reference to the given data buffer until it is destroyed.
  86      *
  87      * @param source    - stream data source
  88      */
  89     [noscript] void setDataSource(in StreamBufferSource source);
  90
  91     [noscript, notxpcom]
  92     size_t SizeOfIncludingThisIfUnshared(in MallocSizeOf aMallocSizeOf);
  93
  94     [noscript, notxpcom]
  95     size_t SizeOfIncludingThisEvenIfShared(in MallocSizeOf aMallocSizeOf);
  96 };