donner::svg::SandboxedFileResourceLoader Class Reference

Interface for loading external resources, such as images. More...

#include "donner/svg/resources/SandboxedFileResourceLoader.h"

Inheritance diagram for donner::svg::SandboxedFileResourceLoader:

Collaboration diagram for donner::svg::SandboxedFileResourceLoader:

Public Member Functions
	SandboxedFileResourceLoader (const std::filesystem::path &root, const std::filesystem::path &documentPath)
	Create a new resource loader that loads files sandboxed within the given root directory.
	SandboxedFileResourceLoader (const SandboxedFileResourceLoader &)=delete
SandboxedFileResourceLoader &	operator= (const SandboxedFileResourceLoader &)=delete
	SandboxedFileResourceLoader (SandboxedFileResourceLoader &&)=delete
SandboxedFileResourceLoader &	operator= (SandboxedFileResourceLoader &&)=delete
	~SandboxedFileResourceLoader () override=default
	Destructor.
std::variant< std::vector< uint8_t >, ResourceLoaderError >	fetchExternalResource (std::string_view url) override
	Fetch external resource from a given URL.
Public Member Functions inherited from donner::svg::ResourceLoaderInterface
	ResourceLoaderInterface ()=default
	Default constructor.
	ResourceLoaderInterface (const ResourceLoaderInterface &)=delete
ResourceLoaderInterface &	operator= (const ResourceLoaderInterface &)=delete
	ResourceLoaderInterface (ResourceLoaderInterface &&)=delete
ResourceLoaderInterface &	operator= (ResourceLoaderInterface &&)=delete
virtual	~ResourceLoaderInterface ()=default
	Destructor.

Detailed Description

Interface for loading external resources, such as images.

To load files from the local filesystem, use SandboxedFileResourceLoader.

Constructor & Destructor Documentation

SandboxedFileResourceLoader()

donner::svg::SandboxedFileResourceLoader::SandboxedFileResourceLoader ( const std::filesystem::path & root, const std::filesystem::path & documentPath )

explicit

Create a new resource loader that loads files sandboxed within the given root directory.

Paths should be relative to the documentPath directory. Paths that use ".." to escape the root directory will be rejected.

Parameters

root	Sandbox directory, loads outside of this directory will be rejected.
documentPath	Path to the document being loaded, used to resolve relative paths.

Member Function Documentation

fetchExternalResource()

std::variant< std::vector< uint8_t >, ResourceLoaderError > donner::svg::SandboxedFileResourceLoader::fetchExternalResource ( std::string_view url )

overridevirtual

Fetch external resource from a given URL.

Parameters

url	URL of the external resource.

Returns

A vector containing the fetched data.

Implements donner::svg::ResourceLoaderInterface.

---

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

• donner/svg/resources/SandboxedFileResourceLoader.h
• donner/svg/resources/SandboxedFileResourceLoader.cc