Interface nsIScriptableBase64EncoderType

nsIScriptableBase64Encoder efficiently encodes the contents of a nsIInputStream to a Base64 string. This avoids the need to read the entire stream into a buffer, and only then do the Base64 encoding.

If you already have a buffer full of data, you should use btoa instead!

Hierarchy

Methods

AddRef QueryInterface Release encodeToCString encodeToString

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

encodeToCString

  • These methods take an nsIInputStream and return a narrow or wide string with the contents of the nsIInputStream base64 encoded.

    The stream passed in must support ReadSegments and must not be a non-blocking stream that will return NS_BASE_STREAM_WOULD_BLOCK. If either of these restrictions are violated we will abort.

    Parameters

    • stream: nsIInputStream
    • length: number

    Returns string

encodeToString

  • Parameters

    • stream: nsIInputStream
    • length: number

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc