Utilities

General Kanzi utility classes and functions. More...

Collaboration diagram for Utilities:

Topics
	File utilities
	File handling utility classes.

Classes
struct	kanzi::enable_bitmask_operators< Enum >
	Enabler template for bitmask operators over an Enum class. More...
class	kanzi::FixedString
	String that points to a string literal. More...
class	kanzi::FlagScopeGuard< FlagValue >
	Scope guard for boolean value. More...
class	kanzi::FlagWaiter
	Waiter object that can block the calling thread until a flag is set. More...

Functions
template<typename Enum >
constexpr bool	kanzi::containsAnyFlag (Enum hay, Enum needle)
	Returns whether a bit field contains any of the bit flags in a given set.
template<typename Enum >
constexpr bool	kanzi::containsFlag (Enum hay, Enum needle)
	Returns whether a bit field contains all the bit flags in a given set.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator& (Enum lhs, Enum rhs)
	Bitwise AND operator between two enum class values.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type	kanzi::operator&= (Enum &lhs, Enum rhs)
	Bitwise AND assignment operator between two enum class values.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator^ (Enum lhs, Enum rhs)
	Bitwise XOR operator between two enum class values.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type	kanzi::operator^= (Enum &lhs, Enum rhs)
	Bitwise XOR assignment operator between two enum class values.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator| (Enum lhs, Enum rhs)
	Bitwise OR operator between two enum class values.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type	kanzi::operator|= (Enum &lhs, Enum rhs)
	Bitwise OR assignment operator between two enum class values.
template<typename Enum >
constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type	kanzi::operator~ (Enum lhs)
	Bitwise NOT operator over an enum class value.

Detailed Description

General Kanzi utility classes and functions.

Function Documentation

operator|()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator| ( Enum lhs, Enum rhs )

constexpr

Bitwise OR operator between two enum class values.

operator&()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator& ( Enum lhs, Enum rhs )

constexpr

Bitwise AND operator between two enum class values.

operator^()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator^ ( Enum lhs, Enum rhs )

constexpr

Bitwise XOR operator between two enum class values.

operator~()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type kanzi::operator~ ( Enum lhs )

constexpr

Bitwise NOT operator over an enum class value.

operator|=()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type kanzi::operator|= ( Enum & lhs, Enum rhs )

constexpr

Bitwise OR assignment operator between two enum class values.

operator&=()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type kanzi::operator&= ( Enum & lhs, Enum rhs )

constexpr

Bitwise AND assignment operator between two enum class values.

operator^=()

template<typename Enum >

constexpr enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type kanzi::operator^= ( Enum & lhs, Enum rhs )

constexpr

Bitwise XOR assignment operator between two enum class values.

containsFlag()

template<typename Enum >

constexpr bool kanzi::containsFlag ( Enum hay, Enum needle )

constexpr

Returns whether a bit field contains all the bit flags in a given set.

Parameters

hay	The bit field to search.
needle	The set of bit flags to look for.

Since

Kanzi 4.0.0

containsAnyFlag()

template<typename Enum >

constexpr bool kanzi::containsAnyFlag ( Enum hay, Enum needle )

constexpr

Returns whether a bit field contains any of the bit flags in a given set.

Parameters

hay	The bit field to search.
needle	The set of bit flags to look for.

Since

Kanzi 4.0.0