Blender: blender::ed::asset::index::AssetIndexFile Class Reference

Blender V5.0

Inherits blender::ed::asset::index::AbstractFile.

Public Member Functions
	AssetIndexFile (AssetLibraryIndex &library_index, StringRef index_file_path)
	AssetIndexFile (AssetLibraryIndex &library_index, BlendFile &asset_filename)
void	mark_as_used ()
const char *	get_file_path () const override
bool	is_older_than (const BlendFile &asset_file) const
bool	constains_entries () const
std::unique_ptr< AssetIndex >	read_contents () const
bool	ensure_parent_path_exists () const
void	write_contents (AssetIndex &content)
Public Member Functions inherited from blender::ed::asset::index::AbstractFile
virtual	~AbstractFile ()=default
bool	exists () const
size_t	get_file_size () const

Public Attributes
AssetLibraryIndex &	library_index
const size_t	MIN_FILE_SIZE_WITH_ENTRIES = 32
std::string	filename

Detailed Description

Definition at line 516 of file asset_indexer.cc.

Constructor & Destructor Documentation

◆ AssetIndexFile() [1/2]

blender::ed::asset::index::AssetIndexFile::AssetIndexFile	(	AssetLibraryIndex &	library_index,
		StringRef	index_file_path )

inline

Definition at line 526 of file asset_indexer.cc.

References filename, and library_index.

Referenced by AssetIndexFile().

◆ AssetIndexFile() [2/2]

blender::ed::asset::index::AssetIndexFile::AssetIndexFile	(	AssetLibraryIndex &	library_index,
		BlendFile &	asset_filename )

inline

Definition at line 531 of file asset_indexer.cc.

References AssetIndexFile(), and library_index.

Member Function Documentation

◆ constains_entries()

bool blender::ed::asset::index::AssetIndexFile::constains_entries ( ) const

inline

Check whether the index file contains entries without opening the file.

Definition at line 557 of file asset_indexer.cc.

References blender::ed::asset::index::AbstractFile::get_file_size(), and MIN_FILE_SIZE_WITH_ENTRIES.

Referenced by blender::ed::asset::index::read_index(), and blender::ed::asset::index::AssetLibraryIndex::remove_broken_index_files().

◆ ensure_parent_path_exists()

bool blender::ed::asset::index::AssetIndexFile::ensure_parent_path_exists ( ) const

inline

Definition at line 578 of file asset_indexer.cc.

References BLI_file_ensure_parent_dir_exists(), and get_file_path().

Referenced by write_contents().

◆ get_file_path()

const char * blender::ed::asset::index::AssetIndexFile::get_file_path ( ) const

inlineoverridevirtual

Implements blender::ed::asset::index::AbstractFile.

Definition at line 541 of file asset_indexer.cc.

References filename.

Referenced by ensure_parent_path_exists(), is_older_than(), blender::ed::asset::index::AssetLibraryIndex::remove_broken_index_files(), blender::ed::asset::index::update_index(), and write_contents().

◆ is_older_than()

bool blender::ed::asset::index::AssetIndexFile::is_older_than ( const BlendFile & asset_file ) const

inline

Returns whether the index file is older than the given asset file.

Definition at line 549 of file asset_indexer.cc.

References BLI_file_older(), get_file_path(), and blender::ed::asset::index::BlendFile::get_file_path().

Referenced by blender::ed::asset::index::read_index().

◆ mark_as_used()

void blender::ed::asset::index::AssetIndexFile::mark_as_used ( )

inline

Definition at line 536 of file asset_indexer.cc.

References blender::ed::asset::index::AssetLibraryIndex::mark_as_used().

Referenced by blender::ed::asset::index::read_index().

◆ read_contents()

std::unique_ptr< AssetIndex > blender::ed::asset::index::AssetIndexFile::read_contents ( ) const

inline

Definition at line 563 of file asset_indexer.cc.

References BLI_SCOPED_DEFER, and blender::io::serialize::JsonFormatter::deserialize().

Referenced by blender::ed::asset::index::read_index().

◆ write_contents()

void blender::ed::asset::index::AssetIndexFile::write_contents ( AssetIndex & content )

inline

Definition at line 583 of file asset_indexer.cc.

References CLOG_ERROR, blender::ed::asset::index::AssetIndex::contents, ensure_parent_path_exists(), get_file_path(), LOG, and blender::io::serialize::JsonFormatter::serialize().

Referenced by blender::ed::asset::index::update_index().

Member Data Documentation

◆ filename

std::string blender::ed::asset::index::AssetIndexFile::filename

Definition at line 524 of file asset_indexer.cc.

Referenced by AssetIndexFile(), get_file_path(), and blender::ed::asset::index::read_index().

◆ library_index

AssetLibraryIndex& blender::ed::asset::index::AssetIndexFile::library_index

Definition at line 518 of file asset_indexer.cc.

Referenced by AssetIndexFile(), and AssetIndexFile().

◆ MIN_FILE_SIZE_WITH_ENTRIES

const size_t blender::ed::asset::index::AssetIndexFile::MIN_FILE_SIZE_WITH_ENTRIES = 32

Asset index files with a size smaller than this attribute would be considered to not contain any entries.

Definition at line 523 of file asset_indexer.cc.

Referenced by constains_entries().

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

asset_indexer.cc