drivers

Documentation

Index

• type Audio
  • func NewAudio(opts ...AudioOption) *Audio
  • func (d Audio) Generate() (captchas.Captcha, error)
• type AudioOption
  • func AudioLangauge(language string) AudioOption
  • func AudioLength(length int) AudioOption
• type Captcha
  • func (c *Captcha) Answer() string
  • func (c *Captcha) EncodeToString() string
  • func (c *Captcha) HTMLField(fieldName string) template.HTML
  • func (c *Captcha) ID() string
  • func (c *Captcha) IsTagAudio() bool
  • func (c *Captcha) MediaAttr() template.HTMLAttr
• type Chinese
  • func NewChinese(opts ...ChineseOption) *Chinese
  • func (d Chinese) Generate() (captchas.Captcha, error)
• type ChineseOption
  • func ChineseBGColor(color *color.RGBA) ChineseOption
  • func ChineseFonts(fonts []string) ChineseOption
  • func ChineseHeight(height int) ChineseOption
  • func ChineseLength(length int) ChineseOption
  • func ChineseNoiseCount(count int) ChineseOption
  • func ChineseSource(source string) ChineseOption
  • func ChineseWidth(width int) ChineseOption
• type Digit
  • func NewDigit(opts ...DigitOption) *Digit
  • func (d Digit) Generate() (captchas.Captcha, error)
• type DigitOption
  • func DigitDotCount(count int) DigitOption
  • func DigitHeight(height int) DigitOption
  • func DigitLength(length int) DigitOption
  • func DigitMaxSkew(maxSkew float64) DigitOption
  • func DigitWidth(width int) DigitOption
• type Math
  • func NewMath(opts ...MathOption) *Math
  • func (d Math) Generate() (captchas.Captcha, error)
• type MathOption
  • func MathBGColor(color *color.RGBA) MathOption
  • func MathFonts(fonts []string) MathOption
  • func MathHeight(height int) MathOption
  • func MathNoiseCount(count int) MathOption
  • func MathWidth(width int) MathOption
• type Str
  • func NewString(opts ...StringOption) *Str
  • func (d Str) Generate() (captchas.Captcha, error)
• type StringOption
  • func StringBGColor(color *color.RGBA) StringOption
  • func StringFonts(fonts []string) StringOption
  • func StringHeight(height int) StringOption
  • func StringLength(length int) StringOption
  • func StringNoiseCount(count int) StringOption
  • func StringSource(source string) StringOption
  • func StringWidth(width int) StringOption

Types

type Audio

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

func NewAudio

func NewAudio(opts ...AudioOption) *Audio

NewAudio returns an audio driver.

func (Audio) Generate

func (d Audio) Generate() (captchas.Captcha, error)

type AudioOption

type AudioOption func(*Audio)

AudioOption is a function that receives a pointer of audio driver.

func AudioLangauge

func AudioLangauge(language string) AudioOption

AudioLangauge sets audio language.

func AudioLength

func AudioLength(length int) AudioOption

AudioLength sets audio length.

type Captcha

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

func (*Captcha) Answer

func (c *Captcha) Answer() string

ID implements Captcha.Answer.

func (*Captcha) EncodeToString

func (c *Captcha) EncodeToString() string

ID implements Captcha.EncodeToString.

func (*Captcha) HTMLField

func (c *Captcha) HTMLField(fieldName string) template.HTML

ID implements Captcha.HTMLField.

func (*Captcha) ID

func (c *Captcha) ID() string

ID implements Captcha.ID.

func (*Captcha) IsTagAudio

func (c *Captcha) IsTagAudio() bool

func (*Captcha) MediaAttr

func (c *Captcha) MediaAttr() template.HTMLAttr

type Chinese

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

func NewChinese

func NewChinese(opts ...ChineseOption) *Chinese

NewChinese returns a chinese driver.

func (Chinese) Generate

func (d Chinese) Generate() (captchas.Captcha, error)

type ChineseOption

type ChineseOption func(*Chinese)

ChineseOption is a function that receives a pointer of chinese driver.

func ChineseBGColor

func ChineseBGColor(color *color.RGBA) ChineseOption

ChineseBGColor sets background color.

func ChineseFonts

func ChineseFonts(fonts []string) ChineseOption

ChineseFonts sets fonts.

func ChineseHeight

func ChineseHeight(height int) ChineseOption

ChineseHeight sets height.

func ChineseLength

func ChineseLength(length int) ChineseOption

ChineseLength sets length.

func ChineseNoiseCount

func ChineseNoiseCount(count int) ChineseOption

ChineseNoiseCount sets noise count.

func ChineseSource

func ChineseSource(source string) ChineseOption

ChineseSource sets source.

func ChineseWidth

func ChineseWidth(width int) ChineseOption

ChineseWidth sets width.

type Digit

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

func NewDigit

func NewDigit(opts ...DigitOption) *Digit

NewDigit return a digit driver.

func (Digit) Generate

func (d Digit) Generate() (captchas.Captcha, error)

type DigitOption

type DigitOption func(*Digit)

DigitOption is a function that receives a pointer of digit driver.

func DigitDotCount

func DigitDotCount(count int) DigitOption

DigitDotCount sets dot count.

func DigitHeight

func DigitHeight(height int) DigitOption

DigitHeight sets height.

func DigitLength

func DigitLength(length int) DigitOption

DigitLength sets length.

func DigitMaxSkew

func DigitMaxSkew(maxSkew float64) DigitOption

DigitMaxSkew sets max skew.

func DigitWidth

func DigitWidth(width int) DigitOption

DigitWidth sets width.

type Math

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

func NewMath

func NewMath(opts ...MathOption) *Math

NewMath return a math driver.

func (Math) Generate

func (d Math) Generate() (captchas.Captcha, error)

type MathOption

type MathOption func(*Math)

MathOption is a function that receives a pointer of math driver.

func MathBGColor

func MathBGColor(color *color.RGBA) MathOption

MathBGColor sets background color.

func MathFonts

func MathFonts(fonts []string) MathOption

MathFonts sets fonts.

func MathHeight

func MathHeight(height int) MathOption

MathHeight sets height.

func MathNoiseCount

func MathNoiseCount(count int) MathOption

MathNoiseCount sets noise count.

func MathWidth

func MathWidth(width int) MathOption

MathWidth sets width.

type Str

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

func NewString

func NewString(opts ...StringOption) *Str

NewString returns a string driver.

func (Str) Generate

func (d Str) Generate() (captchas.Captcha, error)

type StringOption

type StringOption func(*Str)

StringOption is a function that receives a pointer of string driver.

func StringBGColor

func StringBGColor(color *color.RGBA) StringOption

StringBGColor sets background color.

func StringFonts

func StringFonts(fonts []string) StringOption

StringFonts sets fonts.

func StringHeight

func StringHeight(height int) StringOption

StringHeight sets height.

func StringLength

func StringLength(length int) StringOption

StringLength sets length.

func StringNoiseCount

func StringNoiseCount(count int) StringOption

StringNoiseCount sets noise count.

func StringSource

func StringSource(source string) StringOption

StringSource sets source.

func StringWidth

func StringWidth(width int) StringOption

StringWidth sets width.