role

Documentation

Overview

Package role represents the role type in the system.

Index

• Variables
• func ParseToString(usrRoles []Role) []string
• type Role
  • func MustParse(value string) Role
  • func Parse(value string) (Role, error)
  • func ParseMany(roles []string) ([]Role, error)
  • func (r Role) Equal(r2 Role) bool
  • func (r Role) MarshalText() ([]byte, error)
  • func (r Role) String() string

Variables

var (
	Admin = newRole("ADMIN")
	User  = newRole("USER")
)

The set of roles that can be used.

Functions

func ParseToString

func ParseToString(usrRoles []Role) []string

ParseToString takes a collection of user roles and converts them to a slice of string.

Types

type Role

type Role struct {
	// contains filtered or unexported fields
}

Role represents a role in the system.

func MustParse

func MustParse(value string) Role

MustParse parses the string value and returns a role if one exists. If an error occurs the function panics.

func Parse

func Parse(value string) (Role, error)

Parse parses the string value and returns a role if one exists.

func ParseMany

func ParseMany(roles []string) ([]Role, error)

ParseMany takes a collection of strings and converts them to a slice of roles.

func (Role) Equal

func (r Role) Equal(r2 Role) bool

Equal provides support for the go-cmp package and testing.

func (Role) MarshalText

func (r Role) MarshalText() ([]byte, error)

MarshalText provides support for logging and any marshal needs.

func (Role) String

func (r Role) String() string

String returns the name of the role.