le::IDataLoader Class Reference

Interface for loading bytes from a data source (usually the filesystem). More...

#include <le2d/data_loader.hpp>

Inheritance diagram for le::IDataLoader:

Public Member Functions
virtual auto	try_load_bytes (std::vector< std::byte > &out, std::string_view uri) const -> bool=0
auto	load_bytes (std::string_view uri) const -> std::vector< std::byte >
virtual auto	try_load_spirv (std::vector< std::uint32_t > &out, std::string_view uri) const -> bool=0
auto	load_spir_v (std::string_view uri) const -> std::vector< std::uint32_t >
virtual auto	try_load_string (std::string &out, std::string_view uri) const -> bool=0
auto	load_string (std::string_view uri) const -> std::string
auto	try_load_json (dj::Json &out, std::string_view uri) const -> bool
auto	load_json (std::string_view uri) const -> dj::Json
auto	get_json_type_name (std::string_view uri) const -> std::string

Detailed Description

Interface for loading bytes from a data source (usually the filesystem).

Member Function Documentation

get_json_type_name()

auto le::IDataLoader::get_json_type_name

(

std::string_view

uri

)

const -> std::string

Parameters

uri	URI to JSON.

Returns

JSON type name (if present).

load_bytes()

auto le::IDataLoader::load_bytes

(

std::string_view

uri

)

const -> std::vector< std::byte >

Parameters

uri	URI to load from.

Returns

Loaded bytes, empty vector on failure.

load_json()

auto le::IDataLoader::load_json

(

std::string_view

uri

)

const -> dj::Json

Parameters

uri	URI to load from.

Returns

Loaded JSON, empty JSON on failure.

load_spir_v()

auto le::IDataLoader::load_spir_v

(

std::string_view

uri

)

const -> std::vector< std::uint32_t >

Parameters

uri	URI to load from.

Returns

Loaded SPIR-V code, empty vector on failure.

load_string()

auto le::IDataLoader::load_string

(

std::string_view

uri

)

const -> std::string

Parameters

uri	URI to load from.

Returns

Loaded string, empty string on failure.

try_load_bytes()

virtual auto le::IDataLoader::try_load_bytes ( std::vector< std::byte > &  out, std::string_view  uri  ) const -> bool

pure virtual

Parameters

out	Destination buffer.
uri	URI to load from.

Returns

true if successfully loaded.

Implemented in le::FileDataLoader.

try_load_json()

auto le::IDataLoader::try_load_json	(	dj::Json &	out,
		std::string_view	uri
	)		const -> bool

Parameters

out	Destination JSON.
uri	URI to load from.

Returns

true if successfully loaded.

try_load_spirv()

virtual auto le::IDataLoader::try_load_spirv ( std::vector< std::uint32_t > &  out, std::string_view  uri  ) const -> bool

pure virtual

Parameters

out	Destination buffer.
uri	URI to load from.

Returns

true if successfully loaded.

Implemented in le::FileDataLoader.

try_load_string()

virtual auto le::IDataLoader::try_load_string ( std::string &  out, std::string_view  uri  ) const -> bool

pure virtual

Parameters

out	Destination buffer.
uri	URI to load from.

Returns

true if successfully loaded.

Implemented in le::FileDataLoader.

---

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

• data_loader.hpp