File: nsITellableStream.idl

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (34 lines) | stat: -rw-r--r-- 1,044 bytes parent folder | download | duplicates (28) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */


/*
 * nsITellableStream
 *
 * This class is separate from nsISeekableStream in order to let streams to
 * implement ::Tell() without implementing the whole nsISeekableStream
 * interface. Callers can QI the stream to know what is implemented. This is
 * mainly done for nsPipeInputStream.
 *
 *
 * Implementing this interface, streams are able to expose the current offset
 * via ::tell().
 */

#include "nsISupports.idl"

[scriptable, uuid(ee942946-4538-45d2-bf05-ffdbf5932621)]
interface nsITellableStream : nsISupports
{
    /**
     *  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.
     */
    long long tell();
};