xpcom/io/nsIUnicharOutputStream.idl
author Aki Sasaki <asasaki@mozilla.com>
Thu, 15 Feb 2018 18:14:26 -0800
changeset 405423 42a3b4c113542cee47b388879e27163091eed356
parent 363659 e155fa765af299f0e8cfb42e0a1709e5b04928b9
permissions -rw-r--r--
bug 1438735 - balrog scriptworker push and schedule support. r=bhearsum - add balrog submit-toplevel - this replaces the final portion of the updates builder. - rename balrog transform to balrog_submit, because it's for balrog locale submission - make this default to the 'promote' phase. balrog and beetmover currently take the current phase, which isn't always the wanted behavior. - rename balrog publish to balrog schedule - add balrog secondary push and secondary scheduling, for RCs - remove the release_updates transforms - make the task.py balrog transforms smarter - get rid of the release_balrog_publishing transforms; ad a generic worker_type transform - add BALROG_ACTIONS to scriptworker.py - add get_balrog_action_scope() - remove the unused balrog channel scopes MozReview-Commit-ID: 369ACiOAd5F

/* vim:set expandtab ts=4 sw=4 sts=4 cin: */
/* 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"

/**
 * An interface that allows writing unicode data.
 */
[scriptable, uuid(2d00b1bb-8b21-4a63-bcc6-7213f513ac2e)]
interface nsIUnicharOutputStream : nsISupports
{
    /**
     * Write a single character to the stream. When writing many characters,
     * prefer the string-taking write method.
     *
     * @retval true The character was written successfully
     * @retval false Not all bytes of the character could be written.
     */
    boolean write(in unsigned long aCount,
                  [const, array, size_is(aCount)] in char16_t c);

    /**
     * Write a string to the stream.
     *
     * @retval true The string was written successfully
     * @retval false Not all bytes of the string could be written.
     */
    boolean writeString(in AString str);

    /**
     * Flush the stream. This finishes the conversion and writes any bytes that
     * finish the current byte sequence.
     *
     * It does NOT flush the underlying stream.
     */
    void flush();

    /**
     * Close the stream and free associated resources. This also closes the
     * underlying stream.
     */
    void close();
};