InputSource Class Referenceabstract
juce_core » streams

A lightweight object that can create a stream to read some kind of resource. More...

Inheritance diagram for InputSource:

## Public Member Functions

| InputSource ()=default
virtual | ~InputSource ()=default
| Destructor. More...
virtual InputStream * | createInputStream ()=0
| Returns a new InputStream to read this item. More...
virtual InputStream * | createInputStreamFor (const String &relatedItemPath)=0
| Returns a new InputStream to read an item, relative. More...
virtual int64 | hashCode () const =0
| Returns a hash code that uniquely represents this item. More...

## Detailed Description

A lightweight object that can create a stream to read some kind of resource.

This may be used to refer to a file, or some other kind of source, allowing a caller to create an input stream that can read from it when required.

See also
  FileInputSource

## Constructor & Destructor Documentation

## InputSource()

InputSource::InputSource | ( |  | ) |

default

## ~InputSource()

virtual InputSource::~InputSource | ( |  | ) |

virtual default

Destructor.

## Member Function Documentation

## createInputStream()

virtual InputStream* InputSource::createInputStream | ( |  | ) |

pure virtual

Returns a new InputStream to read this item.

Returns
  an inputstream that the caller will delete, or nullptr if the filename isn't found.

Implemented in URLInputSource, and FileInputSource.

## createInputStreamFor()

virtual InputStream* InputSource::createInputStreamFor | ( | const String & | relatedItemPath | ) |

pure virtual

Returns a new InputStream to read an item, relative.

Parameters

  relatedItemPath | the relative pathname of the resource that is required

Returns
  an inputstream that the caller will delete, or nullptr if the item isn't found.

Implemented in URLInputSource, and FileInputSource.

## hashCode()

virtual int64 InputSource::hashCode | ( |  | ) | const

pure virtual

Returns a hash code that uniquely represents this item.

Implemented in URLInputSource, and FileInputSource.

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

- juce_InputSource.h