omni

namespace omni

Main namespace for Omniverse.

Classes

expected

A monad which holds either an expected value (the success case) or an unexpected value (the error case).

function

function< TReturn(TArgs…)>

A polymorphic function wrapper which is compatible with std::function .

move_only_function

move_only_function< Ret(Args…) >

A move-only function wrapper that can store and invoke callable objects.

string

This class is an ABI safe string implementation.

unexpected

The unexpected value of an expected monad. This is used as a convenient mechanism to report the error case when constructing an expected return.

vector

Implementation of an ABI-safe vector container.

vector< bool >

For now, the bool specialization is defined so as to not be used. This way we can decide later if we want to provide an ABI-safe version or not.

Functions

constexpr string::size_type erase(string &str, const U &val)

Erases all instances of val from str .

constexpr string::size_type erase_if(string &str, Pred pred)

Erases all elements of str the satisfy pred .

std::basic_istream< char, std::char_traits< char > > & getline(std::basic_istream< char, std::char_traits< char > > &&input, string &str)

Reads characters from the input stream input and places them in the string str .

std::basic_istream< char, std::char_traits< char > > & getline(std::basic_istream< char, std::char_traits< char > > &&input, string &str, char delim)

Reads characters from the input stream input and places them in the string str .

bool operator!=(const vector< T > &lhs, const vector< T > &rhs)

Compares the contents of two vectors for inequality.

bool operator!=(function< TReturn(TArgs…)> const &func, std::nullptr_t) noexcept

Check if func is activated.

constexpr bool operator!=(const char *lhs, const string &rhs)

Compares lhs and rhs .

bool operator!=(const std::string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

bool operator!=(const string &lhs, const std::string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator!=(expected< TValueLhs, TErrorLhs > const &lhs, TValueRhs const &rhs)

Compare the contents of lhs and rhs for inequality.

bool operator!=(std::nullptr_t, function< TReturn(TArgs…)> const &func) noexcept

Check if func is activated.

constexpr bool operator!=(expected< TValueLhs, TErrorLhs > const &lhs, expected< TValueRhs, TErrorRhs > const &rhs)

Compare the contents of lhs and rhs for inequality.

constexpr bool operator!=(const string &lhs, const char *rhs)

Compares lhs and rhs .

constexpr bool operator!=(const string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator!=(expected< TValueLhs, TErrorLhs > const &lhs, unexpected< TErrorRhs > const &rhs)

Compare the contents of lhs and rhs for inequality.

string operator+(string &&lhs, string &&rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const string &lhs, const string &rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(char lhs, const string &rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(string &&lhs, char rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const char *lhs, const string &rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const std::string &lhs, string &&rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const char *lhs, string &&rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(string &&lhs, const char *rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const string &lhs, string &&rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(string &&lhs, const string &rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const string &lhs, const char *rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const string &lhs, const std::string &rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const string &lhs, char rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(const std::string &lhs, const string &rhs)

Creates a new string by concatenating lhs and rhs .

string operator+(char lhs, string &&rhs)

Creates a new string by concatenating lhs and rhs .

constexpr bool operator<(const string &lhs, const char *rhs)

Compares lhs and rhs .

bool operator<(const std::string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

bool operator<(const vector< T > &lhs, const vector< T > &rhs)

Compares the contents of two vectors lexicographically.

bool operator<(const string &lhs, const std::string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator<(const string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator<(const char *lhs, const string &rhs)

Compares lhs and rhs .

std::basic_ostream< char, std::char_traits< char > > & operator<<(std::basic_ostream< char, std::char_traits< char > > &os, const string &str)

Output stream operator overload.

constexpr bool operator<=(const string &lhs, const char *rhs)

Compares lhs and rhs .

bool operator<=(const std::string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

bool operator<=(const string &lhs, const std::string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator<=(const char *lhs, const string &rhs)

Compares lhs and rhs .

bool operator<=(const vector< T > &lhs, const vector< T > &rhs)

Compares the contents of two vectors lexicographically.

constexpr bool operator<=(const string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

bool operator==(function< TReturn(TArgs…)> const &func, std::nullptr_t) noexcept

Check if func is not activated.

bool operator==(const vector< T > &lhs, const vector< T > &rhs)

Compares the contents of two vectors for equality.

bool operator==(std::nullptr_t, function< TReturn(TArgs…)> const &func) noexcept

Check if func is not activated.

bool operator==(const std::string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

bool operator==(const string &lhs, const std::string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator==(const string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator==(const string &lhs, const char *rhs)

Compares lhs and rhs .

constexpr bool operator==(expected< TValueLhs, TErrorLhs > const &lhs, unexpected< TErrorRhs > const &rhs)

Compare the error contents of lhs with rhs .

constexpr bool operator==(expected< TValueLhs, TErrorLhs > const &lhs, expected< TValueRhs, TErrorRhs > const &rhs)

Compare the contents of lhs and rhs for equality.

constexpr bool operator==(expected< TValueLhs, TErrorLhs > const &lhs, TValueRhs const &rhs)

Compare the contents of lhs with the non expected type rhs .

constexpr bool operator==(const char *lhs, const string &rhs)

Compares lhs and rhs .

bool operator>(const string &lhs, const std::string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator>(const string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator>(const char *lhs, const string &rhs)

Compares lhs and rhs .

constexpr bool operator>(const string &lhs, const char *rhs)

Compares lhs and rhs .

bool operator>(const vector< T > &lhs, const vector< T > &rhs)

Compares the contents of two vectors lexicographically.

bool operator>(const std::string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator>=(const char *lhs, const string &rhs)

Compares lhs and rhs .

constexpr bool operator>=(const string &lhs, const char *rhs)

Compares lhs and rhs .

bool operator>=(const std::string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

bool operator>=(const vector< T > &lhs, const vector< T > &rhs)

Compares the contents of two vectors lexicographically.

bool operator>=(const string &lhs, const std::string &rhs) noexcept

Compares lhs and rhs .

constexpr bool operator>=(const string &lhs, const string &rhs) noexcept

Compares lhs and rhs .

std::basic_istream< char, std::char_traits< char > > & operator>>(std::basic_istream< char, std::char_traits< char > > &is, string &str)

Input stream operator overload.

double stod(const string &str, std::size_t *pos=nullptr)

Interprets the string str as a floating point value.

float stof(const string &str, std::size_t *pos=nullptr)

Interprets the string str as a floating point value.

int stoi(const string &str, std::size_t *pos=nullptr, int base=10)

Interprets the string str as a signed integer value.

long stol(const string &str, std::size_t *pos=nullptr, int base=10)

Interprets the string str as a signed integer value.

long double stold(const string &str, std::size_t *pos=nullptr)

Interprets the string str as a floating point value.

long long stoll(const string &str, std::size_t *pos=nullptr, int base=10)

Interprets the string str as a signed integer value.

unsigned long stoul(const string &str, std::size_t *pos=nullptr, int base=10)

Interprets the string str as a unsigned integer value.

unsigned long long stoull(const string &str, std::size_t *pos=nullptr, int base=10)

Interprets the string str as a unsigned integer value.

void swap(string &lhs, string &rhs) noexcept

Swaps lhs and rhs via lhs.swap(rhs) .

void swap(function< TReturn(TArgs…)> &a, function< TReturn(TArgs…)> &b) noexcept

Swap a and b by function::swap .

string to_string(long long value)

Converts the numerical value value to a string.

string to_string(unsigned long long value)

Converts the numerical value value to a string.

string to_string(double value)

Converts the numerical value value to a string.

string to_string(unsigned long value)

Converts the numerical value value to a string.

string to_string(float value)

Converts the numerical value value to a string.

string to_string(long double value)

Converts the numerical value value to a string.

string to_string(unsigned value)

Converts the numerical value value to a string.

string to_string(int value)

Converts the numerical value value to a string.

string to_string(long value)

Converts the numerical value value to a string.

unexpected() -> unexpected< void >

An empty unexpected() constructor call implies TError = void .

unexpected(T) -> unexpected< T >

Allow deduction of TError from the unexpected(t) expression.

Namespaces

core

Core functionality for Omniverse Interfaces.

detail

Internal implementation details namespace.

experimental

Namespace for experimental Interfaces and functionality.

ext

Namespace for Omniverse Extension system.

extras

common namespace for extra helper functions and classes.

kit

Namespace for kit.

log

Multi-channel logging.

platforminfo

Platform and operating system info namespace.

python

Python related functionality.

str

Namespace for various string helper classes, interfaces, and functions.

structuredlog

Structured logging and Telemetry.

telemetry

Structs

formatted_t

A flag type to select the omni::string constructor that allows printf style formatting.

vformatted_t

A flag type to select the omni::string constructor that allows vprintf style formatting.

Typedefs

span

An object that refers to a contiguous sequence of objects.

string_view

basic_string_view<char>

u16string_view

basic_string_view<char16_t>

u32string_view

basic_string_view<char32_t>

wstring_view

basic_string_view<wchar_t>

Variables

constexpr auto dynamic_extent

A constant of type size_t that is used to differentiate carb::cpp::span of static and dynamic extent.

constexpr formatted_t formatted

A flag value to select the omni::string constructor that allows printf style formatting.

constexpr vformatted_t vformatted

A flag value to select the omni::string constructor that allows vprintf style formatting.