service

Documentation

Index

• Variables
• type Backend
• type TokenGenerator
  • func NewTokenGenerator() TokenGenerator
  • func TokenGeneratorWithSalt(salt string) TokenGenerator
• type UniqID
  • func (u *UniqID) Next() int64

Variables

var InvalidTokenErr = status.Errorf(codes.InvalidArgument, "The field `page_token` is invalid.")

InvalidTokenErr is the error returned if the token provided is not parseable by the TokenGenerator.

Types

type Backend

type Backend interface {
	RegisterGRPC(*grpc.Server)
}

Backend abstracts a registrable GRPC service.

type TokenGenerator

type TokenGenerator interface {
	ForIndex(int) string
	GetIndex(string) (int, error)
}

TokenGenerator generates a page token for a given index.

func NewTokenGenerator

func NewTokenGenerator() TokenGenerator

NewTokenGenerator provides a new instance of a TokenGenerator.

func TokenGeneratorWithSalt

func TokenGeneratorWithSalt(salt string) TokenGenerator

TokenGeneratorWithSalt provieds an instance of a TokenGenerator which uses the given salt.

type UniqID

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

UniqID provides a numerical id that is guaranteed to be unique.

func (*UniqID) Next

func (u *UniqID) Next() int64

Next gets the next unique id.