hyperscan

package

Go to main page

Versions in this module

v1

v1.2.2

Apr 18, 2023

v1.2.1

Dec 17, 2022

v1.2.0

Apr 11, 2022

Changes in this version

+ type CompileError = hs.CompileError

type DbInfo

+ func (i DbInfo) Parse() (version, features, mode string, err error)

+ type Error = hs.Error

+ const ErrInsufficientSpace

type ExprExt

+ func NewExprExt(exts ...Ext) (ext *ExprExt)

type Pattern

+ Expression string

+ func (p *Pattern) Pattern() *hs.Pattern

+ func (p *Pattern) Patterns() []*hs.Pattern

type Patterns

+ func (p Patterns) Patterns() (r []*hs.Pattern)

v1.1.1

Nov 24, 2021

Changes in this version

+ var ErrNoFound = errors.New("no found")

+ var ErrTooManyMatches = errors.New("too many matches")

+ var ErrUnexpected = errors.New("unexpected")

type BlockDatabase

+ func NewManagedBlockDatabase(patterns ...*Pattern) (BlockDatabase, error)

+ type Builder interface

+ Build func(mode ModeFlag) (Database, error)

+ ForPlatform func(mode ModeFlag, platform Platform) (Database, error)

+ type Literal struct

+ Flags CompileFlag

+ Id int

+ func NewLiteral(expr string, flags ...CompileFlag) *Literal

+ func ParseLiteral(s string) (*Literal, error)

+ func (lit *Literal) Build(mode ModeFlag) (Database, error)

+ func (lit *Literal) ForPlatform(mode ModeFlag, platform Platform) (Database, error)

+ func (lit *Literal) Info() (*ExprInfo, error)

+ func (lit *Literal) IsValid() bool

+ func (lit *Literal) String() string

+ type Literals []*Literal

+ func (literals Literals) Build(mode ModeFlag) (Database, error)

+ func (literals Literals) ForPlatform(mode ModeFlag, platform Platform) (Database, error)

type Pattern

+ func (p *Pattern) Build(mode ModeFlag) (Database, error)

+ func (p *Pattern) ForPlatform(mode ModeFlag, platform Platform) (Database, error)

type Patterns

+ func (p Patterns) Build(mode ModeFlag) (Database, error)

+ func (p Patterns) ForPlatform(mode ModeFlag, platform Platform) (Database, error)

type Scratch

+ func NewManagedScratch(db Database) (*Scratch, error)

type StreamDatabase

+ func NewManagedStreamDatabase(patterns ...*Pattern) (StreamDatabase, error)

v1.1.0

Mar 26, 2021

Changes in this version

type ExprExt

+ func ParseExprExt(s string) (ext *ExprExt, err error)

+ func (ext *ExprExt) String() string

+ func (ext *ExprExt) With(exts ...Ext) *ExprExt

+ type Ext func(ext *ExprExt)

type ExtFlag

+ const ExtEditDistance

+ const ExtHammingDistance

+ const ExtMaxOffset

+ const ExtMinLength

+ const ExtMinOffset

type Pattern

+ func (p *Pattern) Ext() (*ExprExt, error)

+ func (p *Pattern) WithExt(exts ...Ext) *Pattern

+ type Patterns []*Pattern

+ func ParsePatterns(r io.Reader) (patterns Patterns, err error)

type StreamScanner

+ Scan func(reader io.Reader, scratch *Scratch, handler MatchHandler, context interface{}) error

v1.0.0

Aug 27, 2018

Changes in this version

+ const CreditCard

+ const EmailAddress

+ const FloatNumber

+ const IPv4Address

+ const UnboundedMaxWidth

+ func Match(pattern string, data []byte) (bool, error)

+ func MatchReader(pattern string, reader io.Reader) (bool, error)

+ func MatchString(pattern string, s string) (matched bool, err error)

+ func Quote(s string) string

+ func SerializedDatabaseSize(data []byte) (int, error)

+ func ValidPlatform() error

+ func Version() string

+ type BlockDatabase interface

+ func NewBlockDatabase(patterns ...*Pattern) (BlockDatabase, error)

+ func UnmarshalBlockDatabase(data []byte) (BlockDatabase, error)

+ type BlockMatcher interface

+ Find func(data []byte) []byte

+ FindAll func(data []byte, n int) [][]byte

+ FindAllIndex func(data []byte, n int) [][]int

+ FindAllString func(s string, n int) []string

+ FindAllStringIndex func(s string, n int) [][]int

+ FindIndex func(data []byte) []int

+ FindString func(s string) string

+ FindStringIndex func(s string) []int

+ Match func(b []byte) bool

+ MatchString func(s string) bool

+ type BlockScanner interface

+ Scan func(data []byte, scratch *Scratch, handler MatchHandler, context interface{}) error

+ type CompileFlag uint

+ const AllowEmpty

+ const Caseless

+ const Combination

+ const DotAll

+ const MultiLine

+ const PrefilterMode

+ const Quiet

+ const SingleMatch

+ const SomLeftMost

+ const UnicodeProperty

+ const Utf8Mode

+ func ParseCompileFlag(s string) (CompileFlag, error)

+ func (flags CompileFlag) String() string

+ type CpuFeature int

+ const AVX2

+ const AVX512

+ type Database interface

+ Close func() error

+ Info func() (DbInfo, error)

+ Marshal func() ([]byte, error)

+ Size func() (int, error)

+ Unmarshal func([]byte) error

+ func Compile(expr string) (Database, error)

+ func MustCompile(expr string) Database

+ func UnmarshalDatabase(data []byte) (Database, error)

+ type DatabaseBuilder struct

+ Mode ModeFlag

+ Patterns []*Pattern

+ Platform Platform

+ func (b *DatabaseBuilder) AddExpressionWithFlags(expr Expression, flags CompileFlag) *DatabaseBuilder

+ func (b *DatabaseBuilder) AddExpressions(exprs ...Expression) *DatabaseBuilder

+ func (b *DatabaseBuilder) Build() (Database, error)

+ type DbInfo string

+ func SerializedDatabaseInfo(data []byte) (DbInfo, error)

+ func (i DbInfo) Mode() (ModeFlag, error)

+ func (i DbInfo) String() string

+ func (i DbInfo) Version() (string, error)

+ type ExprExt struct

+ EditDistance uint

+ Flags ExtFlag

+ HammingDistance uint

+ MaxOffset uint64

+ MinLength uint64

+ MinOffset uint64

+ type ExprInfo struct

+ AtEndOfData bool

+ MaxWidth uint

+ MinWidth uint

+ OnlyAtEndOfData bool

+ ReturnUnordered bool

+ type Expression string

+ func (e Expression) String() string

+ type ExtFlag uint

+ const EditDistance

+ const HammingDistance

+ const MaxOffset

+ const MinLength

+ const MinOffset

+ type HsError int

+ const ErrArchError

+ const ErrBadAlign

+ const ErrBadAlloc

+ const ErrCompileError

+ const ErrDatabaseModeError

+ const ErrDatabasePlatformError

+ const ErrDatabaseVersionError

+ const ErrInvalid

+ const ErrNoMemory

+ const ErrScanTerminated

+ const ErrScratchInUse

+ const ErrSuccess

+ func (e HsError) Error() string

+ type MatchContext interface

+ Database func() Database

+ Scratch func() Scratch

+ UserData func() interface{}

+ type MatchEvent interface

+ Flags func() ScanFlag

+ From func() uint64

+ Id func() uint

+ To func() uint64

+ type MatchHandler hsMatchEventHandler

+ type ModeFlag uint

+ const BlockMode

+ const ModeMask

+ const NoStreamMode

+ const SomHorizonLargeMode

+ const SomHorizonMediumMode

+ const SomHorizonSmallMode

+ const StreamMode

+ const VectoredMode

+ func ParseModeFlag(s string) (ModeFlag, error)

+ func (m ModeFlag) String() string

+ type Pattern struct

+ Flags CompileFlag

+ Id int

+ func NewPattern(expr string, flags CompileFlag) *Pattern

+ func ParsePattern(s string) (*Pattern, error)

+ func (p *Pattern) Info() (*ExprInfo, error)

+ func (p *Pattern) IsValid() bool

+ func (p *Pattern) String() string

+ type Platform interface

+ CpuFeatures func() CpuFeature

+ Tune func() TuneFlag

+ func NewPlatform(tune TuneFlag, cpu CpuFeature) Platform

+ func PopulatePlatform() Platform

+ type ScanFlag uint

+ type Scratch struct

+ func NewScratch(db Database) (*Scratch, error)

+ func (s *Scratch) Clone() (*Scratch, error)

+ func (s *Scratch) Free() error

+ func (s *Scratch) Realloc(db Database) error

+ func (s *Scratch) Size() (int, error)

+ type Stream interface

+ Clone func() (Stream, error)

+ Close func() error

+ Reset func() error

+ Scan func(data []byte) error

+ type StreamCompressor interface

+ Compress func(stream Stream) ([]byte, error)

+ Expand func(buf []byte, flags ScanFlag, scratch *Scratch, handler MatchHandler, ...) (Stream, error)

+ ResetAndExpand func(stream Stream, buf []byte, flags ScanFlag, scratch *Scratch, ...) (Stream, error)

+ type StreamDatabase interface

+ StreamSize func() (int, error)

+ func NewLargeStreamDatabase(patterns ...*Pattern) (StreamDatabase, error)

+ func NewMediumStreamDatabase(patterns ...*Pattern) (StreamDatabase, error)

+ func NewStreamDatabase(patterns ...*Pattern) (StreamDatabase, error)

+ func UnmarshalStreamDatabase(data []byte) (StreamDatabase, error)

+ type StreamMatcher interface

+ Find func(reader io.ReadSeeker) []byte

+ FindAll func(reader io.ReadSeeker, n int) [][]byte

+ FindAllIndex func(reader io.Reader, n int) [][]int

+ FindIndex func(reader io.Reader) []int

+ Match func(reader io.Reader) bool

+ type StreamScanner interface

+ Open func(flags ScanFlag, scratch *Scratch, handler MatchHandler, context interface{}) (Stream, error)

+ type TuneFlag int

+ const Broadwell

+ const Generic

+ const Goldmont

+ const Haswell

+ const IvyBridge

+ const SandyBridge

+ const Silvermont

+ const Skylake

+ const SkylakeServer

+ type VectoredDatabase interface

+ func NewVectoredDatabase(patterns ...*Pattern) (VectoredDatabase, error)

+ func UnmarshalVectoredDatabase(data []byte) (VectoredDatabase, error)

+ type VectoredMatcher interface

+ type VectoredScanner interface

+ Scan func(data [][]byte, scratch *Scratch, handler MatchHandler, context interface{}) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL