Index

Modules: hyperscan, hyperscan/bindings.

API symbols

clone:

• hyperscan: proc clone(s: Scratch): Scratch

close:

• hyperscan: proc close(stream: Stream; cb: MatchCallback = nil)

compile:

• hyperscan: proc compile(patterns: openArray[Pattern]; mode: cuint = HS_MODE_BLOCK): Database
• hyperscan: proc compile(pattern: string; flags: cuint = 0; mode: cuint = HS_MODE_BLOCK): Database

compileLit:

• hyperscan: proc compileLit(pattern: string; flags: cuint = 0; mode: cuint = HS_MODE_BLOCK): Database

Database:

• hyperscan: type Database

deserialize:

• hyperscan: proc deserialize(data: openArray[byte]): Database

ExpressionInfo:

• hyperscan: object ExpressionInfo

expressionInfo:

• hyperscan: proc expressionInfo(pattern: string; flags: cuint = 0): ExpressionInfo

HsAllocFunc:

• bindings: type HsAllocFunc

hs_alloc_scratch:

• bindings: proc hs_alloc_scratch(db: HsDatabasePtr; scratch: ptr HsScratchPtr): HsError

HS_ARCH_ERROR:

• bindings: const HS_ARCH_ERROR

HS_BAD_ALIGN:

• bindings: const HS_BAD_ALIGN

HS_BAD_ALLOC:

• bindings: const HS_BAD_ALLOC

hs_clone_scratch:

• bindings: proc hs_clone_scratch(src: HsScratchPtr; dest: ptr HsScratchPtr): HsError

hs_close_stream:

• bindings: proc hs_close_stream(id: HsStreamPtr; scratch: HsScratchPtr; onEvent: MatchEventHandler; ctxt: pointer): HsError

hs_compile:

• bindings: proc hs_compile(expression: cstring; flags: cuint; mode: cuint; platform: HsPlatformInfoPtr; db: ptr HsDatabasePtr; error: ptr HsCompileErrorPtr): HsError

HsCompileError:

• bindings: object HsCompileError

HsCompileErrorPtr:

• bindings: type HsCompileErrorPtr

hs_compile_ext_multi:

• bindings: proc hs_compile_ext_multi(expressions: ptr cstring; flags: ptr cuint; ids: ptr cuint; ext: ptr ptr HsExprExt; elements: cuint; mode: cuint; platform: HsPlatformInfoPtr; db: ptr HsDatabasePtr; error: ptr HsCompileErrorPtr): HsError

hs_compile_lit:

• bindings: proc hs_compile_lit(expression: cstring; flags: cuint; len: csize_t; mode: cuint; platform: HsPlatformInfoPtr; db: ptr HsDatabasePtr; error: ptr HsCompileErrorPtr): HsError

hs_compile_lit_multi:

• bindings: proc hs_compile_lit_multi(expressions: ptr cstring; flags: ptr cuint; ids: ptr cuint; lens: ptr csize_t; elements: cuint; mode: cuint; platform: HsPlatformInfoPtr; db: ptr HsDatabasePtr; error: ptr HsCompileErrorPtr): HsError

hs_compile_multi:

• bindings: proc hs_compile_multi(expressions: ptr cstring; flags: ptr cuint; ids: ptr cuint; elements: cuint; mode: cuint; platform: HsPlatformInfoPtr; db: ptr HsDatabasePtr; error: ptr HsCompileErrorPtr): HsError

HS_COMPILER_ERROR:

• bindings: const HS_COMPILER_ERROR

hs_compress_stream:

• bindings: proc hs_compress_stream(stream: HsStreamPtr; buf: ptr UncheckedArray[byte]; buf_space: csize_t; used_space: ptr csize_t): HsError

hs_copy_stream:

• bindings: proc hs_copy_stream(to_id: ptr HsStreamPtr; from_id: HsStreamPtr): HsError

HS_CPU_FEATURES_AVX2:

• bindings: const HS_CPU_FEATURES_AVX2

HS_CPU_FEATURES_AVX512:

• bindings: const HS_CPU_FEATURES_AVX512

HS_CPU_FEATURES_AVX512VBMI:

• bindings: const HS_CPU_FEATURES_AVX512VBMI

HsDatabase:

• bindings: object HsDatabase

hs_database_info:

• bindings: proc hs_database_info(database: HsDatabasePtr; info: ptr cstring): HsError

HsDatabasePtr:

• bindings: type HsDatabasePtr

hs_database_size:

• bindings: proc hs_database_size(database: HsDatabasePtr; database_size: ptr csize_t): HsError

HS_DB_MODE_ERROR:

• bindings: const HS_DB_MODE_ERROR

HS_DB_PLATFORM_ERROR:

• bindings: const HS_DB_PLATFORM_ERROR

HS_DB_VERSION_ERROR:

• bindings: const HS_DB_VERSION_ERROR

hs_deserialize_database:

• bindings: proc hs_deserialize_database(bytes: cstring; length: csize_t; db: ptr HsDatabasePtr): HsError

hs_deserialize_database_at:

• bindings: proc hs_deserialize_database_at(bytes: cstring; length: csize_t; db: HsDatabasePtr): HsError

HsError:

• bindings: type HsError

HsException:

• hyperscan: object HsException

hs_expand_stream:

• bindings: proc hs_expand_stream(db: HsDatabasePtr; stream: ptr HsStreamPtr; buf: ptr UncheckedArray[byte]; buf_size: csize_t): HsError

hs_expression_ext_info:

• bindings: proc hs_expression_ext_info(expression: cstring; flags: cuint; ext: HsExprExtPtr; info: ptr HsExprInfoPtr; error: ptr HsCompileErrorPtr): HsError

hs_expression_info:

• bindings: proc hs_expression_info(expression: cstring; flags: cuint; info: ptr HsExprInfoPtr; error: ptr HsCompileErrorPtr): HsError

HsExprExt:

• bindings: object HsExprExt

HsExprExtPtr:

• bindings: type HsExprExtPtr

HsExprInfo:

• bindings: object HsExprInfo

HsExprInfoPtr:

• bindings: type HsExprInfoPtr

HS_EXT_FLAG_EDIT_DISTANCE:

• bindings: const HS_EXT_FLAG_EDIT_DISTANCE

HS_EXT_FLAG_HAMMING_DISTANCE:

• bindings: const HS_EXT_FLAG_HAMMING_DISTANCE

HS_EXT_FLAG_MAX_OFFSET:

• bindings: const HS_EXT_FLAG_MAX_OFFSET

HS_EXT_FLAG_MIN_LENGTH:

• bindings: const HS_EXT_FLAG_MIN_LENGTH

HS_EXT_FLAG_MIN_OFFSET:

• bindings: const HS_EXT_FLAG_MIN_OFFSET

HS_FLAG_ALLOWEMPTY:

• bindings: const HS_FLAG_ALLOWEMPTY

HS_FLAG_CASELESS:

• bindings: const HS_FLAG_CASELESS

HS_FLAG_COMBINATION:

• bindings: const HS_FLAG_COMBINATION

HS_FLAG_DOTALL:

• bindings: const HS_FLAG_DOTALL

HS_FLAG_MULTILINE:

• bindings: const HS_FLAG_MULTILINE

HS_FLAG_PREFILTER:

• bindings: const HS_FLAG_PREFILTER

HS_FLAG_QUIET:

• bindings: const HS_FLAG_QUIET

HS_FLAG_SINGLEMATCH:

• bindings: const HS_FLAG_SINGLEMATCH

HS_FLAG_SOM_LEFTMOST:

• bindings: const HS_FLAG_SOM_LEFTMOST

HS_FLAG_UCP:

• bindings: const HS_FLAG_UCP

HS_FLAG_UTF8:

• bindings: const HS_FLAG_UTF8

hs_free_compile_error:

• bindings: proc hs_free_compile_error(error: HsCompileErrorPtr): HsError

hs_free_database:

• bindings: proc hs_free_database(db: HsDatabasePtr): HsError

HsFreeFunc:

• bindings: type HsFreeFunc

hs_free_scratch:

• bindings: proc hs_free_scratch(scratch: HsScratchPtr): HsError

HS_INSUFFICIENT_SPACE:

• bindings: const HS_INSUFFICIENT_SPACE

HS_INVALID:

• bindings: const HS_INVALID

HS_MODE_BLOCK:

• bindings: const HS_MODE_BLOCK

HS_MODE_NOSTREAM:

• bindings: const HS_MODE_NOSTREAM

HS_MODE_SOM_HORIZON_LARGE:

• bindings: const HS_MODE_SOM_HORIZON_LARGE

HS_MODE_SOM_HORIZON_MEDIUM:

• bindings: const HS_MODE_SOM_HORIZON_MEDIUM

HS_MODE_SOM_HORIZON_SMALL:

• bindings: const HS_MODE_SOM_HORIZON_SMALL

HS_MODE_STREAM:

• bindings: const HS_MODE_STREAM

HS_MODE_VECTORED:

• bindings: const HS_MODE_VECTORED

HS_NOMEM:

• bindings: const HS_NOMEM

HS_OFFSET_PAST_HORIZON:

• bindings: const HS_OFFSET_PAST_HORIZON

hs_open_stream:

• bindings: proc hs_open_stream(db: HsDatabasePtr; flags: cuint; stream: ptr HsStreamPtr): HsError

HsPlatformInfo:

• bindings: object HsPlatformInfo

HsPlatformInfoPtr:

• bindings: type HsPlatformInfoPtr

hs_populate_platform:

• bindings: proc hs_populate_platform(platform: HsPlatformInfoPtr): HsError

hs_reset_and_copy_stream:

• bindings: proc hs_reset_and_copy_stream(to_id: HsStreamPtr; from_id: HsStreamPtr; scratch: HsScratchPtr; onEvent: MatchEventHandler; context: pointer): HsError

hs_reset_and_expand_stream:

• bindings: proc hs_reset_and_expand_stream(to_stream: HsStreamPtr; buf: ptr UncheckedArray[byte]; buf_size: csize_t; scratch: HsScratchPtr; onEvent: MatchEventHandler; context: pointer): HsError

hs_reset_stream:

• bindings: proc hs_reset_stream(id: HsStreamPtr; flags: cuint; scratch: HsScratchPtr; onEvent: MatchEventHandler; context: pointer): HsError

hs_scan:

• bindings: proc hs_scan(db: HsDatabasePtr; data: cstring; length: cuint; flags: cuint; scratch: HsScratchPtr; onEvent: MatchEventHandler; context: pointer): HsError

hs_scan_stream:

• bindings: proc hs_scan_stream(id: HsStreamPtr; data: cstring; length: cuint; flags: cuint; scratch: HsScratchPtr; onEvent: MatchEventHandler; ctxt: pointer): HsError

HS_SCAN_TERMINATED:

• bindings: const HS_SCAN_TERMINATED

hs_scan_vector:

• bindings: proc hs_scan_vector(db: HsDatabasePtr; data: ptr cstring; length: ptr cuint; count: cuint; flags: cuint; scratch: HsScratchPtr; onEvent: MatchEventHandler; context: pointer): HsError

HsScratch:

• bindings: object HsScratch

HS_SCRATCH_IN_USE:

• bindings: const HS_SCRATCH_IN_USE

HsScratchPtr:

• bindings: type HsScratchPtr

hs_scratch_size:

• bindings: proc hs_scratch_size(scratch: HsScratchPtr; scratch_size: ptr csize_t): HsError

hs_serialize_database:

• bindings: proc hs_serialize_database(db: HsDatabasePtr; bytes: ptr cstring; length: ptr csize_t): HsError

hs_serialized_database_info:

• bindings: proc hs_serialized_database_info(bytes: cstring; length: csize_t; info: ptr cstring): HsError

hs_serialized_database_size:

• bindings: proc hs_serialized_database_size(bytes: cstring; length: csize_t; deserialized_size: ptr csize_t): HsError

hs_set_allocator:

• bindings: proc hs_set_allocator(alloc_func: HsAllocFunc; free_func: HsFreeFunc): HsError

hs_set_database_allocator:

• bindings: proc hs_set_database_allocator(alloc_func: HsAllocFunc; free_func: HsFreeFunc): HsError

hs_set_misc_allocator:

• bindings: proc hs_set_misc_allocator(alloc_func: HsAllocFunc; free_func: HsFreeFunc): HsError

hs_set_scratch_allocator:

• bindings: proc hs_set_scratch_allocator(alloc_func: HsAllocFunc; free_func: HsFreeFunc): HsError

hs_set_stream_allocator:

• bindings: proc hs_set_stream_allocator(alloc_func: HsAllocFunc; free_func: HsFreeFunc): HsError

HsStream:

• bindings: object HsStream

HsStreamPtr:

• bindings: type HsStreamPtr

hs_stream_size:

• bindings: proc hs_stream_size(database: HsDatabasePtr; stream_size: ptr csize_t): HsError

HS_SUCCESS:

• bindings: const HS_SUCCESS

HS_TUNE_FAMILY_BDW:

• bindings: const HS_TUNE_FAMILY_BDW

HS_TUNE_FAMILY_GENERIC:

• bindings: const HS_TUNE_FAMILY_GENERIC

HS_TUNE_FAMILY_GLM:

• bindings: const HS_TUNE_FAMILY_GLM

HS_TUNE_FAMILY_HSW:

• bindings: const HS_TUNE_FAMILY_HSW

HS_TUNE_FAMILY_ICL:

• bindings: const HS_TUNE_FAMILY_ICL

HS_TUNE_FAMILY_ICX:

• bindings: const HS_TUNE_FAMILY_ICX

HS_TUNE_FAMILY_IVB:

• bindings: const HS_TUNE_FAMILY_IVB

HS_TUNE_FAMILY_SKL:

• bindings: const HS_TUNE_FAMILY_SKL

HS_TUNE_FAMILY_SKX:

• bindings: const HS_TUNE_FAMILY_SKX

HS_TUNE_FAMILY_SLM:

• bindings: const HS_TUNE_FAMILY_SLM

HS_TUNE_FAMILY_SNB:

• bindings: const HS_TUNE_FAMILY_SNB

HS_UNKNOWN_ERROR:

• bindings: const HS_UNKNOWN_ERROR

hs_valid_platform:

• bindings: proc hs_valid_platform(): HsError

hs_version:

• bindings: proc hs_version(): cstring

info:

• hyperscan: proc info(db: Database): string

MatchCallback:

• hyperscan: type MatchCallback

MatchEventHandler:

• bindings: type MatchEventHandler

newScratch:

• hyperscan: proc newScratch(db: Database): Scratch

openStream:

• hyperscan: proc openStream(db: Database; scratch: Scratch): Stream

Pattern:

• hyperscan: object Pattern

reset:

• hyperscan: proc reset(stream: Stream; cb: MatchCallback = nil)

scan:

• hyperscan: proc scan(db: Database; data: string; cb: MatchCallback): bool
• hyperscan: proc scan(db: Database; data: string; scratch: Scratch; cb: MatchCallback): bool
• hyperscan: proc scan(stream: Stream; data: string; cb: MatchCallback): bool

Scratch:

• hyperscan: type Scratch

serialize:

• hyperscan: proc serialize(db: Database): seq[byte]

size:

• hyperscan: proc size(db: Database): csize_t
• hyperscan: proc size(s: Scratch): csize_t

Stream:

• hyperscan: type Stream

validPlatform:

• hyperscan: proc validPlatform()

version:

• hyperscan: proc version(): string