core

Documentation

Index

• Constants
• Variables
• func IsValid(perm Permission) bool
• func WithPerm(ctx context.Context, perm Permission) context.Context
• type DBPrefix
• type LogField
• type Measurement
• type Page
  • func (o *Page) GetLimit() int64
  • func (o *Page) GetSkip() int64
• type PermKey
• type Permission
  • func AdaptOldStrategy(perm Permission) []Permission
• type UserState
  • func (us UserState) String() string

Constants

const (
	NotDelete = 0
	Deleted   = 1
)

const AuthorizationHeader = "Authorization"

const BuildVersion = "1.11.0"

const EmptyString = ""

Variables

var CurrentCommit string

var PermArr = []Permission{
	PermAdmin, PermSign, PermWrite, PermRead,
}

var TagFields = []LogField{
	FieldName,
	FieldIP,
	FieldLevel,
	FieldSvcName,
}

var Version = BuildVersion + CurrentCommit

Functions

func IsValid

func IsValid(perm Permission) bool

func WithPerm

func WithPerm(ctx context.Context, perm Permission) context.Context

Types

type DBPrefix

type DBPrefix = []byte

type LogField

type LogField = string

const (
	FieldName    LogField = "name"
	FieldIP      LogField = "ip"
	FieldLevel   LogField = "level"
	FieldSvcName LogField = "svcName"
	FieldSpanId  LogField = "spanId"
	FieldPreHost LogField = "preHost"
	FieldElapsed LogField = "elapsed"
	FieldToken   LogField = "token"
)

type Measurement

type Measurement = string

const (
	MTMethod Measurement = "method"
)

type Page

type Page struct {
	Skip  int64 `form:"skip" json:"skip"`
	Limit int64 `form:"limit" json:"limit"`
}

func (*Page) GetLimit

func (o *Page) GetLimit() int64

func (*Page) GetSkip

func (o *Page) GetSkip() int64

type PermKey

type PermKey int

var PermCtxKey PermKey

type Permission

type Permission = string

const (
	// When changing these, update docs/API.md too
	PermRead  Permission = "read" // default
	PermWrite Permission = "write"
	PermSign  Permission = "sign"  // Use wallet keys for signing
	PermAdmin Permission = "admin" // Manage permissions
)

func AdaptOldStrategy

func AdaptOldStrategy(perm Permission) []Permission

type UserState

type UserState int

const (
	UserStateUndefined UserState = iota
	UserStateEnabled
	UserStateDisabled
)

For compatibility with older versions of the API

func (UserState) String

func (us UserState) String() string