Interface nsIStorageStreamType

The nsIStorageStream interface maintains an internal data buffer that can be filled using a single output stream. One or more independent input streams can be created to read the data from the buffer non-destructively.

Hierarchy

Properties

length: uint32_t

The length attribute indicates the total number of bytes stored in the nsIStorageStream internal buffer, regardless of any consumption by input streams. Assigning to the length field can be used to truncate the buffer data, but can not be used when either the instance's output stream is in use.

See

#writeInProgress

writeInProgress: boolean

True, when output stream has not yet been Close'ed

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

  • Get a reference to the one and only output stream for this instance. The zero-based startPosition argument is used is used to set the initial write cursor position. The startPosition cannot be set larger than the current buffer length. Calling this method has the side-effect of truncating the internal buffer to startPosition bytes.

    Parameters

    • startPosition: int32_t

    Returns nsIOutputStream

  • Initialize the stream, setting up the amount of space that will be allocated for the stream's backing-store.

    Parameters

    • segmentSize: uint32_t

      Size of each segment. Must be a power of two.

    • maxSize: uint32_t

      Maximum total size of this stream. length will always be less than or equal to this value. Passing UINT32_MAX is safe.

    Returns void

  • Create a new input stream to read data (written by the singleton output stream) from the internal buffer. Multiple, independent input streams can be created.

    Parameters

    • startPosition: int32_t

    Returns nsIInputStream

Generated using TypeDoc