openpit::accounts::Accounts Class Reference

Account-group and account/group block administration for an engine. More...

#include <accounts.hpp>

Public Member Functions
	Accounts ()=default
	Accounts (OpenPitEngine *engine) noexcept
void	Block (::openpit::param::AccountId account, std::string_view reason) const noexcept
std::optional< AccountBlockError >	BlockGroup (::openpit::param::AccountGroupId group, std::string_view reason) const
std::optional<::openpit::param::AccountGroupId >	GroupOf (::openpit::param::AccountId account) const
std::optional< AccountGroupError >	RegisterGroup (const std::vector<::openpit::param::AccountId > &accounts, ::openpit::param::AccountGroupId group) const
std::optional< AccountBlockError >	ReplaceBlockReason (::openpit::param::AccountId account, std::string_view reason) const
std::optional< AccountBlockError >	ReplaceGroupBlockReason (::openpit::param::AccountGroupId group, std::string_view reason) const
void	Unblock (::openpit::param::AccountId account) const noexcept
std::optional< AccountBlockError >	UnblockGroup (::openpit::param::AccountGroupId group) const
std::optional< AccountGroupError >	UnregisterGroup (const std::vector<::openpit::param::AccountId > &accounts, ::openpit::param::AccountGroupId group) const

Detailed Description

Account-group and account/group block administration for an engine.

Constructor & Destructor Documentation

Accounts() [1/2]

openpit::accounts::Accounts::Accounts ( )

default

Accounts() [2/2]

openpit::accounts::Accounts::Accounts ( OpenPitEngine * engine )

inlineexplicitnoexcept

Member Function Documentation

Block()

void openpit::accounts::Accounts::Block ( ::openpit::param::AccountId account, std::string_view reason ) const

inlinenoexcept

BlockGroup()

std::optional< AccountBlockError > openpit::accounts::Accounts::BlockGroup ( ::openpit::param::AccountGroupId group, std::string_view reason ) const

inlinenodiscard

GroupOf()

std::optional<::openpit::param::AccountGroupId > openpit::accounts::Accounts::GroupOf ( ::openpit::param::AccountId account ) const

inlinenodiscard

RegisterGroup()

std::optional< AccountGroupError > openpit::accounts::Accounts::RegisterGroup ( const std::vector<::openpit::param::AccountId > & accounts, ::openpit::param::AccountGroupId group ) const

inlinenodiscard

ReplaceBlockReason()

std::optional< AccountBlockError > openpit::accounts::Accounts::ReplaceBlockReason ( ::openpit::param::AccountId account, std::string_view reason ) const

inlinenodiscard

ReplaceGroupBlockReason()

std::optional< AccountBlockError > openpit::accounts::Accounts::ReplaceGroupBlockReason ( ::openpit::param::AccountGroupId group, std::string_view reason ) const

inlinenodiscard

Unblock()

void openpit::accounts::Accounts::Unblock ( ::openpit::param::AccountId account ) const

inlinenoexcept

UnblockGroup()

std::optional< AccountBlockError > openpit::accounts::Accounts::UnblockGroup ( ::openpit::param::AccountGroupId group ) const

inlinenodiscard

UnregisterGroup()

std::optional< AccountGroupError > openpit::accounts::Accounts::UnregisterGroup ( const std::vector<::openpit::param::AccountId > & accounts, ::openpit::param::AccountGroupId group ) const

inlinenodiscard