Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Inkscape::IO::BasicInputStream Class Reference

This is the class that most users should inherit, to provide their own streams. More...

#include <inkscapestream.h>

Inheritance diagram for Inkscape::IO::BasicInputStream:
Inkscape::IO::InputStream Inkscape::IO::GzipInputStream Inkscape::IO::XsltInputStream

Public Member Functions

 BasicInputStream (InputStream &sourceStream)
 
 ~BasicInputStream () override=default
 
int available () override
 Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
 
void close () override
 Closes this input stream and releases any system resources associated with the stream.
 
int get () override
 Reads the next byte of data from the input stream.
 
- Public Member Functions inherited from Inkscape::IO::InputStream
 InputStream ()=default
 Constructor.
 
virtual ~InputStream ()=default
 Destructor.
 

Protected Attributes

bool closed
 
InputStream & source
 

Detailed Description

This is the class that most users should inherit, to provide their own streams.

Definition at line 101 of file inkscapestream.h.

Constructor & Destructor Documentation

◆ BasicInputStream()

Inkscape::IO::BasicInputStream::BasicInputStream ( InputStream &  sourceStream)

Definition at line 47 of file inkscapestream.cpp.

References closed.

◆ ~BasicInputStream()

Inkscape::IO::BasicInputStream::~BasicInputStream ( )
overridedefault

Member Function Documentation

◆ available()

int Inkscape::IO::BasicInputStream::available ( )
overridevirtual

Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.

Implements Inkscape::IO::InputStream.

Reimplemented in Inkscape::IO::GzipInputStream, and Inkscape::IO::XsltInputStream.

Definition at line 58 of file inkscapestream.cpp.

References Inkscape::IO::InputStream::available(), closed, and source.

◆ close()

void Inkscape::IO::BasicInputStream::close ( )
overridevirtual

Closes this input stream and releases any system resources associated with the stream.

Implements Inkscape::IO::InputStream.

Reimplemented in Inkscape::IO::GzipInputStream, and Inkscape::IO::XsltInputStream.

Definition at line 70 of file inkscapestream.cpp.

References Inkscape::IO::InputStream::close(), closed, and source.

◆ get()

int Inkscape::IO::BasicInputStream::get ( )
overridevirtual

Reads the next byte of data from the input stream.

-1 if EOF

Implements Inkscape::IO::InputStream.

Reimplemented in Inkscape::IO::GzipInputStream, and Inkscape::IO::XsltInputStream.

Definition at line 81 of file inkscapestream.cpp.

References closed, Inkscape::IO::InputStream::get(), and source.

Member Data Documentation

◆ closed

bool Inkscape::IO::BasicInputStream::closed
protected

Definition at line 118 of file inkscapestream.h.

Referenced by Inkscape::IO::GzipInputStream::available(), available(), BasicInputStream(), Inkscape::IO::GzipInputStream::close(), close(), Inkscape::IO::XsltInputStream::close(), Inkscape::IO::GzipInputStream::get(), get(), and Inkscape::IO::XsltInputStream::get().

◆ source

InputStream& Inkscape::IO::BasicInputStream::source
protected

Definition at line 120 of file inkscapestream.h.

Referenced by available(), close(), get(), Inkscape::IO::GzipInputStream::load(), and Inkscape::IO::XsltInputStream::XsltInputStream().

The documentation for this class was generated from the following files: