Struct xpcom::interfaces::nsISearchableInputStream [] [src]

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

interface nsISearchableInputStream : nsISupports

/**
 * XXX this interface doesn't really belong in here.  It is here because
 * currently nsPipeInputStream is the only implementation of this interface.
 */

Methods

impl nsISearchableInputStream
[src]

[src]

Cast this nsISearchableInputStream to one of its base interfaces.

impl nsISearchableInputStream
[src]

[src]

/**
     * Searches for a string in the input stream. Since the stream has a notion
     * of EOF, it is possible that the string may at some time be in the
     * buffer, but is is not currently found up to some offset. Consequently,
     * both the found and not found cases return an offset:
     *    if found, return offset where it was found
     *    if not found, return offset of the first byte not searched
     * In the case the stream is at EOF and the string is not found, the first
     * byte not searched will correspond to the length of the buffer.
     */

void search (in string forString, in boolean ignoreCase, out boolean found, out unsigned long offsetSearchedTo);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsISearchableInputStream
[src]

IID: nsIID = nsID(2352607074, 63433, 4564, [152, 245, 0, 16, 131, 1, 14, 155])

[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 nsISearchableInputStream
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsISearchableInputStream
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.