A structure that specifies data for an import session. More...

#include <CeresEngine/Resource/Importer/ResourceImporter.hpp>

Public Attributes
const UPtr< ResourceImportOptions >	importOptions
	A pointer to the import options to be used for the request.

const ResourceTypeInfo *	typeInfo
	Specifies the type of resource to import.

ResourceImporter *const	importer
	The importer that successfully peeked the file.

URLResponse	urlResponse
	The URL response for the request that may have been performed for file peeking.

InputStream	inputStream
	Only defined if `urlResponse` is defined.

Detailed Description

A structure that specifies data for an import session.

Member Data Documentation

◆ importer

ResourceImporter* const CeresEngine::ResourceImporterSession::importer

The importer that successfully peeked the file.

If multiple resource importers were successful, the one with the highest score will be picked.

◆ importOptions

const UPtr<ResourceImportOptions> CeresEngine::ResourceImporterSession::importOptions

A pointer to the import options to be used for the request.

Specifies a set of options that customize the resource importer behavior.

◆ inputStream

InputStream CeresEngine::ResourceImporterSession::inputStream

Only defined if urlResponse is defined.

Points to the input stream that was used for peeking. Unlike a regular InputStream from the URLResponse, this stream is buffered and allows seeking back the contents that were read from the peek operation.

◆ typeInfo

const ResourceTypeInfo* CeresEngine::ResourceImporterSession::typeInfo

Specifies the type of resource to import.

The importer must specify whether it can import the given format or not.

◆ urlResponse

URLResponse CeresEngine::ResourceImporterSession::urlResponse

The URL response for the request that may have been performed for file peeking.

If this is not empty, the response can be used to read the file contents.

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Resource/Importer/ResourceImporter.hpp