dom

Documentation

Overview

Package dom contains common domain (business-logic) entities.

Index

• Variables
• func NewID() string
• type Auth
• type Name
  • func NewName(collection, id string) Name
  • func ParseName(collection, name string) (*Name, error)
  • func (name Name) ID() string
  • func (name Name) String() string
• type UserName
  • func NewUserName(userID string) UserName
  • func ParseUserName(name string) (*UserName, error)

Variables

var (
	NoName Name
	NoUser UserName
)

Empty values.

var (
	ErrInvalidName = errors.New("invalid name")
)

Errors.

Functions

func NewID

func NewID() string

NewID returns cryptographically secure unique ID with 16 to 63 [a-z0-9] characters and at least 64 bit entropy.

Types

type Auth

type Auth struct {
	UserName UserName
	Admin    bool
}

Auth should contain all authentication and authorization info needed to execute any operation on behalf of some user.

type Name

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

Name is an identifier of some entity in format "{collection}/{id}".

func NewName

func NewName(collection, id string) Name

NewName creates and returns Name with given collection and id.

func ParseName

func ParseName(collection, name string) (*Name, error)

ParseName returns ErrInvalidName if name doesn't belong to collection.

func (Name) ID

func (name Name) ID() string

ID returns "{id}" part of the name.

func (Name) String

func (name Name) String() string

String returns "{collection}/{id}" or empty string for NoName.

type UserName

type UserName struct{ Name }

UserName is a Name within "users" collection.

func NewUserName

func NewUserName(userID string) UserName

NewUserName converts user's ID to UserName.

func ParseUserName

func ParseUserName(name string) (*UserName, error)

ParseUserName returns ErrInvalidName if name doesn't belong to "users" collection.