Interface nsIRandomAccessStreamType

nsIRandomAccessStream

An interface which supports both reading and writing to a storage starting at the current offset. Both the input stream and the output stream share the offset in the stream. Read operations invoked on the input stream start at the offset and advance it past the bytes read. Write operations invoked on the output stream start the offset and advance it past the bytes written. The offset can be set to an arbitrary value prior reading or writting. Each call to getInputStream or getOutputStream always returns the same object, rather than creating a new stream. It's recommended for objects implementing this interface to also implement nsIInputStream and nsIOutputStream, so they can be easilly used with e.g. NS_AsyncCopy.

Hierarchy

Methods

  • 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

  • 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

  • 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

  • Parameters

    • params: RandomAccessStreamParamsRef

    Returns bool

  • This method always returns the same object.

    Returns nsIInputStream

  • This method always returns the same object.

    Returns nsIOutputStream

  • Like getInputStream but infallible.

    Returns nsIInputStream

  • Like getOutputStream but infallible.

    Returns nsIOutputStream

  • seek

    This method moves the stream offset of the steam implementing this interface.

    Throws

    NS_BASE_STREAM_CLOSED if called on a closed stream.

    Parameters

    • whence: number

      specifies how to interpret the 'offset' parameter in setting the stream offset associated with the implementing stream.

    • offset: number

      specifies a value, in bytes, that is used in conjunction with the 'whence' parameter to set the stream offset of the implementing stream. A negative value causes seeking in the reverse direction.

    Returns void

  • Parameters

    • aCallbacks: nsIInterfaceRequestor

    Returns RandomAccessStreamParams

  • setEOF

    This method truncates the stream at the current offset.

    Throws

    NS_BASE_STREAM_CLOSED if called on a closed stream.

    Returns void

  • tell

    This method reports the current offset, in bytes, from the start of the stream.

    Throws

    NS_BASE_STREAM_CLOSED if called on a closed stream.

    Returns number

Generated using TypeDoc