Maze Builder Docs 8.2.1
Loading...
Searching...
No Matches
mazes::processed_text Class Referencefinal

Class for managing processed text resources. More...

#include <processed_text.h>

Public Member Functions

artifacts get_dirty () const noexcept
 Gets the dirty (unprocessed) artifact and the processed artifact.
 
artifacts get_processed () const noexcept
 Gets the processed artifact.
 
void set_dirty (artifacts anything) noexcept
 Sets the dirty (unprocessed) artifact and the processed artifact.
 
void set_processed (artifacts anything) noexcept
 Sets the processed artifact.
 
bool set (const std::string_view sv) noexcept
 Required by resource_management::load(id, string_view). Stores sv as the dirty (unprocessed) value; returns true on success.
 
bool is_clean () const noexcept
 Checks if the dirty artifact is clean - empty or null.
 

Detailed Description

Class for managing processed text resources.

Member Function Documentation

◆ get_dirty()

artifacts mazes::processed_text::get_dirty ( ) const
inlinenodiscardnoexcept

Gets the dirty (unprocessed) artifact and the processed artifact.

Returns
The dirty artifact

◆ get_processed()

artifacts mazes::processed_text::get_processed ( ) const
inlinenodiscardnoexcept

Gets the processed artifact.

Returns
The processed artifact

◆ is_clean()

bool mazes::processed_text::is_clean ( ) const
inlinenodiscardnoexcept

Checks if the dirty artifact is clean - empty or null.

clean artifacts are considered non-empty or don't care

Returns
True if the dirty artifact is clean, false otherwise

◆ set_dirty()

void mazes::processed_text::set_dirty ( artifacts anything)
inlinenoexcept

Sets the dirty (unprocessed) artifact and the processed artifact.

Parameters
anything

◆ set_processed()

void mazes::processed_text::set_processed ( artifacts anything)
inlinenoexcept

Sets the processed artifact.

Parameters
anythingThe artifact to set as processed

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