extras#

Fully qualified name: omni::extras

namespace extras#: common namespace for extra helper functions and classes.

Classes#

ForceSymbolLink: Helper class to force the linking of a C++ symbol.
PrivacySettings: Static helper class to provide standardized access to the telemetry privacy setting values.
ScratchBuffer: A templated helper class to provide a simple resizable scratch buffer.
UniqueApp: Helper class to manage a unique app.

Enumerations#

ConsentLevel: Consent level names.

Functions#

bool endsWith(const std::string &str, const std::string &ending): Checks a string to see if it ends with a given suffix.
omni::core::Result fillOutArray(T *outArray, SizeType *outArrayCount, SizeType requiredCount, Callable &&fillFn): Fills the array given by outArray by calling fillFn.
std::vector< std::string > getDirectoryItems(const std::string &folder): Returns a list of all files and sub-folders in the given folder.
std::vector< std::string > getDirectoryItemsOfType(const std::string &folder, carb::filesystem::DirectoryItemType type): Returns a list of either files or sub-folders in the given folder.
int getDockerCpuLimit() noexcept: Attempts to read the current effective CPU usage quota for processes in a container.
carb::filesystem::IFileSystem * getFileSystem(): Helper function for acquiring and caching the filesystem.
omni::core::Result getOutArray(GetCallable &&getFn, FillCallable &&fillFn, uint32_t stackCount=(4096/sizeof(T)), uint32_t maxRetryCount=(UINT32_MAX - 1)): Retrieves an array of unknown size using getFn and passes it to fillFn .
std::vector< std::string > getSubfolders(const std::vector< std::string > &folders): Helper function to gather all sub-folders within an array of sub-folders.
std::vector< std::string > getSubfolders(const std::string &folder): Helper function to gather all sub-folders within a given folder.
bool gitHashFromOmniverseVersion(const extras::SemanticVersion &version, std::string &outHash): Attempts to parse the Git hash from an Omniverse-specific semantic version.
bool isAnyVersion(const SemanticVersion &v): Checks if the given SemanticVersion has negative major, minor and patch values.
bool isPathEqual(const std::string &strLeft, const std::string &strRight): Checks if two given file paths are equal with case sensitivity based on the platform.
bool isRunningInContainer(): Attempts to detect whether this process is running inside a container.
std::string & ltrim(std::string &s, const char *t=kTrimCharsDefault): Performs an in-place left-trim on a given string.
bool operator<(const SemanticVersion &lhs, const SemanticVersion &rhs): Less-than operator for two semantic versions.
bool operator==(const SemanticVersion &lhs, const SemanticVersion &rhs): Equality operator for two semantic versions.
int prereleaseCmp(const char *x, const char *y): Semantic Version pre-release comparator according to rules at https://semver.org/#spec-item-11 .
int prereleaseCmp(const std::string &x, const std::string &y): Semantic Version pre-release comparator according to rules at https://semver.org/#spec-item-11 .
std::pair< bool, std::string > readFile(const char *path): Reads file content into a string.
void replaceAll(std::string &str, const std::string &subStr, const std::string &replaceWith): Replaces all instances of a substring within a given string with a replacement value.
std::string resolvePath(const std::string &path, const std::string &root={}): Resolves a given path by resolving all Tokens and optionally prepending the given root path.
std::string & rtrim(std::string &s, const char *t=kTrimCharsDefault): Performs an in-place right-trim on a given string.
std::vector< std::string > split(const std::string &s, char d, size_t count=std::numeric_limits< size_t >::max()): Splits a string based on a delimiter.
bool startsWith(const std::string &str, const std::string &prefix): Checks a string to see if it begins with a given prefix.
bool stringCompareCaseInsensitive(const std::string &str1, const std::string &str2): Checks two strings for equality in an ASCII case-insensitive manner.
bool stringToInt2(const std::string &str, carb::Int2 &outResult, const char *delims=kInt2Delimiters): Converts a string value to an Int2 representation, that is, a two-component vector.
bool stringToInteger(const std::string &str, int32_t &outResult): Converts a given string to a 32-bit signed integer value.
bool stringToVersion(const std::string &str, SemanticVersion &outVersion): Parses a given string into a semantic version.
SemanticVersion stringToVersionOrDefault(const std::string &str): Parses a string to a semantic version, or a default value if parsing fails.
void toLower(std::string &str): Transforms a string to lowercase in-place.
std::string & trim(std::string &s, const char *t=kTrimCharsDefault): Performs an in-place trim (from both sides) on a given string.
std::string trimCopy(std::string s, const char *t=kTrimCharsDefault): Performs a trim (from both sides) on a given string, returning a copy.
int versionsCmp(const VersionT &lhs, const VersionT &rhs): Less-than comparator for two versions.

Structs#

SemanticVersion: Version struct, follows Semantic Versioning 2.0.

Typedefs#

PathEqual: Custom equality functor for a case sensitive or insensitive map lookup.
PathGreater: Custom greater-than functor for a case sensitive or insensitive map lookup.
PathHash: Custom hash functor for a case sensitive or insensitive hash based on the OS.
PathLess: Custom less-than functor for a case sensitive or insensitive map lookup.
PathMap: A map to store file paths and associated data according to local OS rules.
UnorderedPathMap: An unordered map to store file paths and associated data according to local OS rules.

Variables#

constexpr char kInt2Delimiters: Default delimiters for stringToInt2 .
constexpr char kTrimCharsDefault: Default whitespace characters for string trimming functions.