dpp::permission Class Reference

Represents a permission bitmask (refer to enum dpp::permissions) which are hold in an uint64_t. More...

#include <permissions.h>

Collaboration diagram for dpp::permission:

Public Member Functions
	permission (const uint64_t &value)
	Construct a permission object. More...
	permission ()
	Construct a permission object. More...
	operator uint64_t () const
	For acting like an integer. More...
	operator uint64_t & ()
	For acting like an integer. More...
template<typename... T>
bool	has (T... values) const
	Check for permission flags set. It uses the Bitwise AND operator. More...
template<typename... T>
std::enable_if<(std::is_convertible< T, uint64_t >::value &&...), permission & >::type	add (T... values)
	Add a permission with the Bitwise OR operation. More...
template<typename... T>
std::enable_if<(std::is_convertible< T, uint64_t >::value &&...), permission & >::type	set (T... values)
	Assign a permission. This will reset the bitmask to the new value. More...
template<typename... T>
std::enable_if<(std::is_convertible< T, uint64_t >::value &&...), permission & >::type	remove (T... values)
	Remove a permission with the Bitwise NOT operation. More...

Protected Attributes
uint64_t	value
	The permission bitmask value. More...

Detailed Description

Represents a permission bitmask (refer to enum dpp::permissions) which are hold in an uint64_t.

Constructor & Destructor Documentation

permission() [1/2]

dpp::permission::permission

(

const uint64_t &

value

)

Construct a permission object.

Parameters

value

A permission bitmask

permission() [2/2]

dpp::permission::permission

(

)

Construct a permission object.

Member Function Documentation

add()

template<typename... T>

std::enable_if<(std::is_convertible< T, uint64_t >::value &&...), permission & >::type dpp::permission::add ( T...  values )

inline

Add a permission with the Bitwise OR operation.

Template Parameters

T	one or more uint64_t permission bits

Parameters

values

The permissions (from dpp::permissions) to add

Example:

permission.add(dpp::p_view_channel, dpp::p_send_messages);
// Adds p_view_channel and p_send_messages to the permission bitmask

Returns

permission& reference to self for chaining

has()

template<typename... T>

bool dpp::permission::has ( T...  values ) const

inline

Check for permission flags set. It uses the Bitwise AND operator.

Template Parameters

T	one or more uint64_t permission bits

Parameters

values

The permissions (from dpp::permissions) to check for

Example:

bool is_mod = permission.has(dpp::p_kick_members, dpp::p_ban_members);
// Returns true if the permission bitmask contains p_kick_members and p_ban_members

Returns

bool True if it has all the given permissions

operator uint64_t()

dpp::permission::operator uint64_t

(

)

const

For acting like an integer.

Returns

The permission bitmask value

operator uint64_t &()

dpp::permission::operator uint64_t &

(

)

For acting like an integer.

Returns

A reference to the permission bitmask value

remove()

template<typename... T>

std::enable_if<(std::is_convertible< T, uint64_t >::value &&...), permission & >::type dpp::permission::remove ( T...  values )

inline

Remove a permission with the Bitwise NOT operation.

Template Parameters

T	one or more uint64_t permission bits

Parameters

values

The permissions (from dpp::permissions) to remove

Example:

permission.remove(dpp::p_view_channel, dpp::p_send_messages);
// Removes p_view_channel and p_send_messages permission

Returns

permission& reference to self for chaining

set()

template<typename... T>

std::enable_if<(std::is_convertible< T, uint64_t >::value &&...), permission & >::type dpp::permission::set ( T...  values )

inline

Assign a permission. This will reset the bitmask to the new value.

Template Parameters

T	one or more uint64_t permission bits

Parameters

values

The permissions (from dpp::permissions) to set

Example:

permission.set(dpp::p_view_channel, dpp::p_send_messages);

Returns

permission& reference to self for chaining

Member Data Documentation

value

uint64_t dpp::permission::value

protected

The permission bitmask value.