role

Documentation

Index

• Variables
• func Clean(name string, r Role, sim bool) (ok bool)
• func CleanS(s string) string
• func List(role Role) (people []string, total int, err error)
• func PeopleStmt(role Role, softDel bool) string
• func Rename(replacement, name string, r Role) (count int64, err error)
• func Trim(s string) string
• type Role
  • func Roles(r string) Role
  • func (r Role) String() string

Examples

• List
• Role

Variables

var (
	ErrRenAll    = errors.New("cannot rename everyone, only people tied to specific roles can be renamed")
	ErrNoName    = errors.New("a name of the person must be provided")
	ErrNoReplace = errors.New("a replacement name must be provided")
	ErrRole      = errors.New("unknown role")
)

Functions

func Clean

func Clean(name string, r Role, sim bool) (ok bool)

Clean fixes and saves a malformed name.

func CleanS

func CleanS(s string) string

CleanS separates and fixes the substrings of s.

func List

func List(role Role) (people []string, total int, err error)

List people filtered by a role.

Example

package main

import (
	"fmt"

	"github.com/Defacto2/df2/pkg/people/internal/role"
)

func main() {
	r := role.Musicians
	_, total, err := role.List(r)
	if err != nil {
		fmt.Print(err)
	}
	fmt.Printf("%s found? %v", r, total > 0)
}

Output:

musicians found? true

func PeopleStmt

func PeopleStmt(role Role, softDel bool) string

PeopleStmt returns a complete SQL WHERE statement for people that are filtered by roles.

func Rename

func Rename(replacement, name string, r Role) (count int64, err error)

Rename replaces the persons using name with the replacement. The task must be limited names associated to a Role.

func Trim

func Trim(s string) string

Trim fixes any malformed strings.

Types

type Role

type Role int

Role are jobs that categorize persons.

Example

package main

import (
	"fmt"

	"github.com/Defacto2/df2/pkg/people/internal/role"
)

func main() {
	r := role.Musicians
	fmt.Println(r)
}

Output:

musicians

const (
	Everyone  Role = iota // Everyone displays all people.
	Artists               // Artists are graphic or video.
	Coders                // Coders are programmers.
	Musicians             // Musicians create music or audio.
	Writers               // Writers for the documents.
)

func Roles

func Roles(r string) Role

func (Role) String

func (r Role) String() string