captcha

Documentation

Index

• Variables
• type Captcha
  • func New(options ...Option) *Captcha
  • func (x *Captcha) Create(ctx context.Context, name string, code string, ttl time.Duration) error
  • func (x *Captcha) Delete(ctx context.Context, name string) error
  • func (x *Captcha) Exists(ctx context.Context, name string) (_ bool, err error)
  • func (x *Captcha) Key(name string) string
  • func (x *Captcha) Verify(ctx context.Context, name string, code string) (err error)
• type Option
  • func SetNamespace(v string) Option
  • func SetRedis(v *redis.Client) Option

Variables

var (
	ErrCaptchaNotExists    = errors.NewPublic("the captcha does not exists")
	ErrCaptchaInconsistent = errors.NewPublic("tha captcha is invalid")
)

Types

type Captcha

type Captcha struct {
	Namespace string
	Redis     *redis.Client
}

func New

func New(options ...Option) *Captcha

func (*Captcha) Create

func (x *Captcha) Create(ctx context.Context, name string, code string, ttl time.Duration) error

func (*Captcha) Delete

func (x *Captcha) Delete(ctx context.Context, name string) error

func (*Captcha) Exists

func (x *Captcha) Exists(ctx context.Context, name string) (_ bool, err error)

func (*Captcha) Key

func (x *Captcha) Key(name string) string

func (*Captcha) Verify

func (x *Captcha) Verify(ctx context.Context, name string, code string) (err error)

type Option

type Option func(x *Captcha)

func SetNamespace

func SetNamespace(v string) Option

func SetRedis

func SetRedis(v *redis.Client) Option