types

Documentation

Index

• type AccountPermissions
  • func (ap *AccountPermissions) AddRole(role string) bool
  • func (ap *AccountPermissions) Clone() AccountPermissions
  • func (ap AccountPermissions) HasRole(role string) bool
  • func (ap *AccountPermissions) RmRole(role string) bool
• type BasePermissions
  • func (bp BasePermissions) Compose(bpFallthrough BasePermissions) BasePermissions
  • func (bp BasePermissions) Get(ty PermFlag) (bool, error)
  • func (bp BasePermissions) IsSet(ty PermFlag) bool
  • func (bp BasePermissions) ResultantPerms() PermFlag
  • func (bp *BasePermissions) Set(ty PermFlag, value bool) error
  • func (bp BasePermissions) String() string
  • func (bp *BasePermissions) Unset(ty PermFlag) error
• type ErrInvalidPermission
  • func (e ErrInvalidPermission) Error() string
• type ErrValueNotSet
  • func (e ErrValueNotSet) Error() string
• type PermFlag

Types

type AccountPermissions

type AccountPermissions struct {
	Base  BasePermissions
	Roles []string
}

func (*AccountPermissions) AddRole

func (ap *AccountPermissions) AddRole(role string) bool

Returns true if the role is added, and false if it already exists

func (*AccountPermissions) Clone

func (ap *AccountPermissions) Clone() AccountPermissions

Clone clones the account permissions

func (AccountPermissions) HasRole

func (ap AccountPermissions) HasRole(role string) bool

Returns true if the role is found

func (*AccountPermissions) RmRole

func (ap *AccountPermissions) RmRole(role string) bool

Returns true if the role is removed, and false if it is not found

type BasePermissions

type BasePermissions struct {
	// bit array with "has"/"doesn't have" for each permission
	Perms PermFlag

	// bit array with "set"/"not set" for each permission (not-set should fall back to global)
	SetBit PermFlag
}

Base chain permissions struct

func (BasePermissions) Compose

func (bp BasePermissions) Compose(bpFallthrough BasePermissions) BasePermissions

Returns a BasePermission that matches any permissions set on this BasePermission and falls through to any permissions set on the bpFallthrough

func (BasePermissions) Get

func (bp BasePermissions) Get(ty PermFlag) (bool, error)

Gets the permission value. ErrValueNotSet is returned if the permission's set bits are not all on, and should be caught by caller so the global permission can be fetched

func (BasePermissions) IsSet

func (bp BasePermissions) IsSet(ty PermFlag) bool

Check if the permission is set

func (BasePermissions) ResultantPerms

func (bp BasePermissions) ResultantPerms() PermFlag

Returns the Perms PermFlag masked with SetBit bit field to give the resultant permissions enabled by this BasePermissions

func (*BasePermissions) Set

func (bp *BasePermissions) Set(ty PermFlag, value bool) error

Set a permission bit. Will set the permission's set bit to true.

func (BasePermissions) String

func (bp BasePermissions) String() string

func (*BasePermissions) Unset

func (bp *BasePermissions) Unset(ty PermFlag) error

Set the permission's set bits to false

type ErrInvalidPermission

type ErrInvalidPermission PermFlag

permission number out of bounds

func (ErrInvalidPermission) Error

func (e ErrInvalidPermission) Error() string

type ErrValueNotSet

type ErrValueNotSet PermFlag

set=false. This error should be caught and the global value fetched for the permission by the caller

func (ErrValueNotSet) Error

func (e ErrValueNotSet) Error() string

type PermFlag

type PermFlag uint64

A particular permission