Struct xpcom::interfaces::nsIObjectInputStream [] [src]

#[repr(C)]
pub struct nsIObjectInputStream { /* fields omitted */ }

interface nsIObjectInputStream : nsIBinaryInputStream

/**
 * @see nsIObjectOutputStream
 * @see nsIBinaryInputStream
 */

Methods

impl nsIObjectInputStream
[src]

[src]

Cast this nsIObjectInputStream to one of its base interfaces.

impl nsIObjectInputStream
[src]

[src]

/**
     * Read an object from this stream to satisfy a strong or weak reference
     * to one of its interfaces.  If the interface was not along the primary
     * inheritance chain ending in the "root" or XPCOM-identity nsISupports,
     * readObject will QueryInterface from the deserialized object root to the
     * correct interface, which was specified when the object was serialized.
     *
     * @see nsIObjectOutputStream
     */

nsISupports readObject (in boolean aIsStrongRef);

[src]

[notxpcom] nsresult readID (out nsID aID);

[src]

/**
     * Optimized deserialization support -- see nsIStreamBufferAccess.idl.
     */

[notxpcom] charPtr getBuffer (in uint32_t aLength, in uint32_t aAlignMask);

[src]

[notxpcom] void putBuffer (in charPtr aBuffer, in uint32_t aLength);

Methods from Deref<Target = nsIBinaryInputStream>

[src]

Cast this nsIBinaryInputStream to one of its base interfaces.

[src]

void setInputStream (in nsIInputStream aInputStream);

[src]

/**
     * Read 8-bits from the stream.
     *
     * @return that byte to be treated as a boolean.
     */

boolean readBoolean ();

[src]

uint8_t read8 ();

[src]

uint16_t read16 ();

[src]

uint32_t read32 ();

[src]

uint64_t read64 ();

[src]

float readFloat ();

[src]

double readDouble ();

[src]

/**
     * Read an 8-bit pascal style string from the stream.
     * 32-bit length field, followed by length 8-bit chars.
     */

ACString readCString ();

[src]

/**
     * Read an 16-bit pascal style string from the stream.
     * 32-bit length field, followed by length PRUnichars.
     */

AString readString ();

[src]

/**
     * Read an opaque byte array from the stream.
     *
     * @param aLength the number of bytes that must be read.
     *
     * @throws NS_ERROR_FAILURE if it can't read aLength bytes
     */

void readBytes (in uint32_t aLength, [size_is (aLength), retval] out string aString);

[src]

/**
     * Read an opaque byte array from the stream, storing the results
     * as an array of PRUint8s.
     *
     * @param aLength the number of bytes that must be read.
     *
     * @throws NS_ERROR_FAILURE if it can't read aLength bytes
     */

void readByteArray (in uint32_t aLength, [array, size_is (aLength), retval] out uint8_t aBytes);

Trait Implementations

impl XpCom for nsIObjectInputStream
[src]

IID: nsIID = nsID(1814332934, 20142, 18170, [157, 240, 186, 88, 80, 35, 104, 235])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIObjectInputStream
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIObjectInputStream
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.