Resource implementation for a local file.
More...
#include <resource_locator.h>
|
|
| SimpleLocatedResource ()=default |
| | This is for serialization do not use directly.
|
| | SimpleLocatedResource (std::string url, std::string filename, ResourceLocator::ConstPtr parent=nullptr) |
| | A generic resource.
|
|
| SimpleLocatedResource (const SimpleLocatedResource &)=default |
|
SimpleLocatedResource & | operator= (const SimpleLocatedResource &)=default |
|
| SimpleLocatedResource (SimpleLocatedResource &&)=default |
|
SimpleLocatedResource & | operator= (SimpleLocatedResource &&)=default |
| bool | isFile () const override final |
| | Returns true if the located resource is a local file.
|
| std::string | getUrl () const override final |
| | Get the original URL used to locate the file.
|
| std::string | getFilePath () const override final |
| | Get the file path of the resource. Only valid if isFile() is true.
|
| std::vector< uint8_t > | getResourceContents () const override final |
| | Get the resource as bytes. This function may block.
|
| std::shared_ptr< std::istream > | getResourceContentStream () const override final |
| | Get the resource as a std::istream. This function and the returned stream may block.
|
| Resource::Ptr | locateResource (const std::string &url) const override final |
| | Locate a resource based on a URL.
|
|
bool | operator== (const SimpleLocatedResource &rhs) const |
|
bool | operator!= (const SimpleLocatedResource &rhs) const |
|
bool | operator== (const Resource &rhs) const |
|
bool | operator!= (const Resource &rhs) const |
|
bool | operator== (const ResourceLocator &rhs) const |
|
bool | operator!= (const ResourceLocator &rhs) const |
|
|
template<class Archive> |
| friend | void::tesseract::common::serialize (Archive &ar, SimpleLocatedResource &obj) |
Resource implementation for a local file.
◆ SimpleLocatedResource()
| tesseract::common::SimpleLocatedResource::SimpleLocatedResource |
( |
std::string | url, |
|
|
std::string | filename, |
|
|
ResourceLocator::ConstPtr | parent = nullptr ) |
A generic resource.
- Parameters
-
| url | The url to the resource |
| filename | The file path to the resource |
| parent | The locator used to locate the resource |
◆ isFile()
| bool tesseract::common::SimpleLocatedResource::isFile |
( |
| ) |
const |
|
finaloverridevirtual |
Returns true if the located resource is a local file.
- Returns
- true if the resource is a local file, otherwise false
Implements tesseract::common::Resource.
◆ getUrl()
| std::string tesseract::common::SimpleLocatedResource::getUrl |
( |
| ) |
const |
|
finaloverridevirtual |
◆ getFilePath()
| std::string tesseract::common::SimpleLocatedResource::getFilePath |
( |
| ) |
const |
|
finaloverridevirtual |
◆ getResourceContents()
| std::vector< uint8_t > tesseract::common::SimpleLocatedResource::getResourceContents |
( |
| ) |
const |
|
finaloverridevirtual |
◆ getResourceContentStream()
| std::shared_ptr< std::istream > tesseract::common::SimpleLocatedResource::getResourceContentStream |
( |
| ) |
const |
|
finaloverridevirtual |
Get the resource as a std::istream. This function and the returned stream may block.
- Returns
- A std::istream shared pointer for the resource data
Implements tesseract::common::Resource.
◆ locateResource()
| tesseract::common::Resource::Ptr tesseract::common::SimpleLocatedResource::locateResource |
( |
const std::string & | url | ) |
const |
|
finaloverridevirtual |