Public Member Functions | List of all members
FileUtf8To32ReadResource Class Reference

A read-only file based UTF-8 resource which is read as UTF-32 characters. More...

#include <FileUtf8To32ReadResource.hpp>

Inheritance diagram for FileUtf8To32ReadResource:
[legend]
Collaboration diagram for FileUtf8To32ReadResource:
[legend]

Public Member Functions

 FileUtf8To32ReadResource (const File &file_)
 Create a new file UTF-8 to UTF-32 read resource from the supplied file URI. More...
 
void close () override
 Close the stream(s) in the resource. More...
 
const FilegetFile () const
 Get the file URI. More...
 
std::u32istream & readStream () override
 Get the input stream of the UTF-8 to UTF-32 read resource. More...
 
const Uriuri () const override
 Get the URI associated with this resource. More...
 
- Public Member Functions inherited from Resource
virtual ~Resource ()=default
 Destroy the resource instance. More...
 

Detailed Description

A read-only file based UTF-8 resource which is read as UTF-32 characters.

Constructor & Destructor Documentation

◆ FileUtf8To32ReadResource()

FileUtf8To32ReadResource ( const File file_)
explicit

Create a new file UTF-8 to UTF-32 read resource from the supplied file URI.

Exceptions
NotFoundExceptionif the file does not exist

Member Function Documentation

◆ close()

void close ( )
inlineoverridevirtual

Close the stream(s) in the resource.

Implements Resource.

◆ getFile()

const File& getFile ( ) const

Get the file URI.

Returns
the file URI

◆ readStream()

std::u32istream& readStream ( )
inlineoverridevirtual

Get the input stream of the UTF-8 to UTF-32 read resource.

Implements Utf8To32ReadResource.

◆ uri()

const Uri& uri ( ) const
overridevirtual

Get the URI associated with this resource.

Implements Resource.


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