1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/xpcom/io/nsIConverterOutputStream.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,44 @@
1.4 +/* vim:set expandtab ts=4 sw=4 sts=4 cin: */
1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.8 +
1.9 +#include "nsIUnicharOutputStream.idl"
1.10 +
1.11 +interface nsIOutputStream;
1.12 +
1.13 +/**
1.14 + * This interface allows writing strings to a stream, doing automatic
1.15 + * character encoding conversion.
1.16 + */
1.17 +[scriptable, uuid(4b71113a-cb0d-479f-8ed5-01daeba2e8d4)]
1.18 +interface nsIConverterOutputStream : nsIUnicharOutputStream
1.19 +{
1.20 + /**
1.21 + * Initialize this stream. Must be called before any other method on this
1.22 + * interface, or you will crash. The output stream passed to this method
1.23 + * must not be null, or you will crash.
1.24 + *
1.25 + * @param aOutStream
1.26 + * The underlying output stream to which the converted strings will
1.27 + * be written.
1.28 + * @param aCharset
1.29 + * The character set to use for encoding the characters. A null
1.30 + * charset will be interpreted as UTF-8.
1.31 + * @param aBufferSize
1.32 + * How many bytes to buffer. A value of 0 means that no bytes will be
1.33 + * buffered. Implementations not supporting buffering may ignore
1.34 + * this parameter.
1.35 + * @param aReplacementCharacter
1.36 + * The replacement character to use when an unsupported character is found.
1.37 + * The character must be encodable in the selected character
1.38 + * encoding; otherwise, attempts to write an unsupported character
1.39 + * will throw NS_ERROR_LOSS_OF_SIGNIFICANT_DATA.
1.40 + *
1.41 + * A value of 0x0000 will cause an exception to be thrown upon
1.42 + * attempts to write unsupported characters.
1.43 + */
1.44 + void init(in nsIOutputStream aOutStream, in string aCharset,
1.45 + in unsigned long aBufferSize,
1.46 + in char16_t aReplacementCharacter);
1.47 +};
