From e3d69800cc32a9662095245ab8636aa493d93503 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 18 Oct 2024 08:30:44 +0000 Subject: [PATCH] Update api docs --- docs/api/http.md | 119 +++++++++++++++++++++++++++++++++++------ docs/api/jwt.md | 20 +++---- docs/api/ping.md | 48 ++++++++--------- docs/api/simulator.md | 2 +- docs/api/ssa.md | 23 ++++++++ docs/api/syntaxflow.md | 95 ++++++++++++++++++++++++++++++++ 6 files changed, 255 insertions(+), 52 deletions(-) create mode 100644 docs/api/syntaxflow.md diff --git a/docs/api/http.md b/docs/api/http.md index b0c4e731f..82524898b 100755 --- a/docs/api/http.md +++ b/docs/api/http.md @@ -10,12 +10,13 @@ | [http.Post](#post) |Post 根据指定的 URL 发起 POST 请求，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应结构体引用与错误 ! 已弃用，使用 poc.Post 代替 | | [http.Raw](#raw) |Raw 根据原始请求报文生成请求结构体引用，返回请求结构体引用与错误 注意，此函数只会生成请求结构体引用，不会发起请求 ! 已弃用，使用 poc.HTTP 或 poc.HTTPEx 代替 | | [http.Request](#request) |Request 根据指定的 URL 发起请求，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应结构体引用与错误 ! 已弃用，使用 poc.Do 代替 | -| [http.RequestFaviconHash](#requestfaviconhash) || -| [http.RequestToMD5](#requesttomd5) || -| [http.RequestToMMH3Hash128](#requesttommh3hash128) || -| [http.RequestToMMH3Hash128x64](#requesttommh3hash128x64) || -| [http.RequestToSha1](#requesttosha1) || -| [http.RequestToSha256](#requesttosha256) || +| [http.RequestFaviconHash](#requestfaviconhash) |RequestFaviconHash 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的base64编码的mmh3 hash的结果&lt;响应...| +| [http.RequestToMD5](#requesttomd5) |RequestToMD5 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的md5 hash的结果与错误 | +| [http.RequestToMMH3Hash128](#requesttommh3hash128) |RequestToMMH3Hash128 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的mmh3 hash&lt;128&gt;的结果与错...| +| [http.RequestToMMH3Hash128x64](#requesttommh3hash128x64) |RequestToMMH3Hash128x64 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的mmh3 hash&lt;128x64&gt...| +| [http.RequestToSha1](#requesttosha1) |RequestToSha1 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的sha1 hash的结果与错误 | +| [http.RequestToSha256](#requesttosha256) |RequestToSha256 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的sha256 hash的结果与错误 | +| [http.RequestToSha512](#requesttosha512) |RequestToSha512 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 返回响应主体(body)的sha512 hash的结果与错误 | | [http.body](#body) |body 是一个请求选项参数，用于指定请求体 | | [http.context](#context) |context 是一个请求选项参数，用于设置请求的上下文 | | [http.cookie](#cookie) |header 是一个请求选项参数，用于设置完整的 Cookie 字段 | @@ -293,16 +294,25 @@ rsp, err = http.Request("POST","http://pie.dev/post", http.body("a=b&c=d"), http ### RequestFaviconHash #### 详细描述 +RequestFaviconHash 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的base64编码的mmh3 hash的结果<响应状态码码为2xx时>与错误，常用于计算网站的favicon hash + +Example: +``` +rsp, err = http.RequestFaviconHash("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` #### 定义 -`RequestFaviconHash(urlRaw string) (string, error)` +`RequestFaviconHash(urlRaw string, options ...http_struct.HttpOption) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -314,16 +324,25 @@ rsp, err = http.Request("POST","http://pie.dev/post", http.body("a=b&c=d"), http ### RequestToMD5 #### 详细描述 +RequestToMD5 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的md5 hash的结果与错误 + +Example: +``` +rsp, err = http.RequestToMD5("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` #### 定义 -`RequestToMD5(url string) (string, error)` +`RequestToMD5(urlRaw string, options ...http_struct.HttpOption) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| -| url | `string` | | +| urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -335,16 +354,25 @@ rsp, err = http.Request("POST","http://pie.dev/post", http.body("a=b&c=d"), http ### RequestToMMH3Hash128 #### 详细描述 +RequestToMMH3Hash128 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的mmh3 hash<128>的结果与错误 + +Example: +``` +rsp, err = http.RequestToMMH3Hash128("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` #### 定义 -`RequestToMMH3Hash128(url string) (string, error)` +`RequestToMMH3Hash128(urlRaw string, options ...http_struct.HttpOption) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| -| url | `string` | | +| urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -356,16 +384,25 @@ rsp, err = http.Request("POST","http://pie.dev/post", http.body("a=b&c=d"), http ### RequestToMMH3Hash128x64 #### 详细描述 +RequestToMMH3Hash128x64 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的mmh3 hash<128x64>的结果与错误 + +Example: +``` +rsp, err = http.RequestToMMH3Hash128x64("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` #### 定义 -`RequestToMMH3Hash128x64(url string) (string, error)` +`RequestToMMH3Hash128x64(urlRaw string, options ...http_struct.HttpOption) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| -| url | `string` | | +| urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -377,16 +414,25 @@ rsp, err = http.Request("POST","http://pie.dev/post", http.body("a=b&c=d"), http ### RequestToSha1 #### 详细描述 +RequestToSha1 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的sha1 hash的结果与错误 + +Example: +``` +rsp, err = http.RequestToSha1("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` #### 定义 -`RequestToSha1(url string) (string, error)` +`RequestToSha1(urlRaw string, options ...http_struct.HttpOption) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| -| url | `string` | | +| urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -398,16 +444,55 @@ rsp, err = http.Request("POST","http://pie.dev/post", http.body("a=b&c=d"), http ### RequestToSha256 #### 详细描述 +RequestToSha256 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的sha256 hash的结果与错误 + +Example: +``` +rsp, err = http.RequestToSha256("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` #### 定义 -`RequestToSha256(url string) (string, error)` +`RequestToSha256(urlRaw string, options ...http_struct.HttpOption) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| -| url | `string` | | +| urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | + +#### 返回值 +|返回值(顺序)|返回值类型|返回值解释| +|:-----------|:---------- |:-----------| +| r1 | `string` | | +| r2 | `error` | | + + +### RequestToSha512 + +#### 详细描述 +RequestToSha512 根据指定的 URL 发起 GET 请求，并计算响应体hash，它的第一个参数是 URL ，接下来可以接收零个到多个请求选项，用于对此次请求进行配置，例如设置请求体，设置超时时间等 + +返回响应主体(body)的sha512 hash的结果与错误 + +Example: +``` +rsp, err = http.RequestToSha512("http://pie.dev/post", http.body("a=b&c=d"), http.timeout(10)) +``` + + +#### 定义 + +`RequestToSha512(urlRaw string, options ...http_struct.HttpOption) (string, error)` + +#### 参数 +|参数名|参数类型|参数解释| +|:-----------|:---------- |:-----------| +| urlRaw | `string` | | +| options | `...http_struct.HttpOption` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| diff --git a/docs/api/jwt.md b/docs/api/jwt.md index fd7f5d617..4a4f140a7 100755 --- a/docs/api/jwt.md +++ b/docs/api/jwt.md @@ -50,13 +50,13 @@ ALG_RS512|(string) "RS512"| #### 定义 -`JWSGenerate(alg string, i any, key []byte) (string, error)` +`JWSGenerate(alg string, i map[string]any, key []byte) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | alg | `string` | | -| i | `any` | | +| i | `map[string]any` | | | key | `[]byte` | | #### 返回值 @@ -73,14 +73,14 @@ ALG_RS512|(string) "RS512"| #### 定义 -`JWSGenerateEx(alg string, extraHeader any, i any, key []byte) (string, error)` +`JWSGenerateEx(alg string, extraHeader map[string]any, i map[string]any, key []byte) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | alg | `string` | | -| extraHeader | `any` | | -| i | `any` | | +| extraHeader | `map[string]any` | | +| i | `map[string]any` | | | key | `[]byte` | | #### 返回值 @@ -97,13 +97,13 @@ ALG_RS512|(string) "RS512"| #### 定义 -`JWTGenerate(alg string, i any, key []byte) (string, error)` +`JWTGenerate(alg string, i map[string]any, key []byte) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | alg | `string` | | -| i | `any` | | +| i | `map[string]any` | | | key | `[]byte` | | #### 返回值 @@ -120,14 +120,14 @@ ALG_RS512|(string) "RS512"| #### 定义 -`JWTGenerateEx(alg string, extraHeader any, i any, key []byte) (string, error)` +`JWTGenerateEx(alg string, extraHeader map[string]any, i map[string]any, key []byte) (string, error)` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | alg | `string` | | -| extraHeader | `any` | | -| i | `any` | | +| extraHeader | `map[string]any` | | +| i | `map[string]any` | | | key | `[]byte` | | #### 返回值 diff --git a/docs/api/ping.md b/docs/api/ping.md index b12e8f6f9..54428e101 100755 --- a/docs/api/ping.md +++ b/docs/api/ping.md @@ -24,13 +24,13 @@ #### 定义 -`Ping(target string, opts ..._pingConfigOpt) *pingutil.PingResult` +`Ping(target string, opts ...PingConfigOpt) *pingutil.PingResult` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | target | `string` | | -| opts | `..._pingConfigOpt` | | +| opts | `...PingConfigOpt` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -45,13 +45,13 @@ #### 定义 -`Scan(target string, opts ..._pingConfigOpt) chan *pingutil.PingResult` +`Scan(target string, opts ...PingConfigOpt) chan *pingutil.PingResult` #### 参数 |参数名|参数类型|参数解释| |:-----------|:---------- |:-----------| | target | `string` | | -| opts | `..._pingConfigOpt` | | +| opts | `...PingConfigOpt` | | #### 返回值 |返回值(顺序)|返回值类型|返回值解释| @@ -66,7 +66,7 @@ #### 定义 -`concurrent(i int) _pingConfigOpt` +`concurrent(i int) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -76,7 +76,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### dnsServers @@ -86,7 +86,7 @@ #### 定义 -`dnsServers(i ...string) _pingConfigOpt` +`dnsServers(i ...string) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -96,7 +96,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### dnsTimeout @@ -106,7 +106,7 @@ #### 定义 -`dnsTimeout(i float64) _pingConfigOpt` +`dnsTimeout(i float64) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -116,7 +116,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### excludeHosts @@ -126,7 +126,7 @@ #### 定义 -`excludeHosts(host string) _pingConfigOpt` +`excludeHosts(host string) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -136,7 +136,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### onResult @@ -146,7 +146,7 @@ #### 定义 -`onResult(i func(result *pingutil.PingResult)) _pingConfigOpt` +`onResult(i func(result *pingutil.PingResult)) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -156,7 +156,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### proxy @@ -166,7 +166,7 @@ #### 定义 -`proxy(i ...string) _pingConfigOpt` +`proxy(i ...string) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -176,7 +176,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### scanCClass @@ -186,7 +186,7 @@ #### 定义 -`scanCClass(i bool) _pingConfigOpt` +`scanCClass(i bool) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -196,7 +196,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### skip @@ -206,7 +206,7 @@ #### 定义 -`skip(i bool) _pingConfigOpt` +`skip(i bool) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -216,7 +216,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### tcpPingPorts @@ -226,7 +226,7 @@ #### 定义 -`tcpPingPorts(i string) _pingConfigOpt` +`tcpPingPorts(i string) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -236,7 +236,7 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | ### timeout @@ -246,7 +246,7 @@ #### 定义 -`timeout(i float64) _pingConfigOpt` +`timeout(i float64) PingConfigOpt` #### 参数 |参数名|参数类型|参数解释| @@ -256,6 +256,6 @@ #### 返回值 |返回值(顺序)|返回值类型|返回值解释| |:-----------|:---------- |:-----------| -| r1 | `_pingConfigOpt` | | +| r1 | `PingConfigOpt` | | diff --git a/docs/api/simulator.md b/docs/api/simulator.md index 545d06d4a..5ba406593 100755 --- a/docs/api/simulator.md +++ b/docs/api/simulator.md @@ -7,7 +7,7 @@ htmlChangeMode|(simulator.loginDetectMode) 1| leaklessDefault|(simulator.LeaklessMode) 0| leaklessOff|(simulator.LeaklessMode) -1| leaklessOn|(simulator.LeaklessMode) 1| -simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x278ce40), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x278c880), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x278c800), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x278c640), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x278cba0), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x278c900), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x278c560)}| +simple|(map[string]interface {}) map[string]interface {}{"bodyModifyTarget": "body", "bodyReplaceTarget": "bodyReplace", "createBrowser": (func(...simple.BrowserConfigOpt) *simple.VBrowser)(0x2799620), "headersModifyTarget": "headers", "headless": (func(bool) simple.BrowserConfigOpt)(0x2799060), "hostModifyTarget": "host", "noSandBox": (func(bool) simple.BrowserConfigOpt)(0x2798fe0), "proxy": (func(string, ...string) simple.BrowserConfigOpt)(0x2798e20), "requestModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x2799380), "responseModify": (func(string, simple.ModifyTarget, interface {}) simple.BrowserConfigOpt)(0x27990e0), "wsAddress": (func(string) simple.BrowserConfigOpt)(0x2798d40)}| urlChangeMode|(simulator.loginDetectMode) 0| |函数名|函数描述/介绍| diff --git a/docs/api/ssa.md b/docs/api/ssa.md index 8d1884e1c..85db18d18 100644 --- a/docs/api/ssa.md +++ b/docs/api/ssa.md @@ -9,6 +9,7 @@ Yak|(consts.Language) "yak"| |函数名|函数描述/介绍| |:------|:--------| +| [ssa.NewFromProgramName](#newfromprogramname) || | [ssa.Parse](#parse) || | [ssa.ParseLocalProject](#parselocalproject) || | [ssa.withContext](#withcontext) || @@ -26,6 +27,28 @@ Yak|(consts.Language) "yak"| ## 函数定义 +### NewFromProgramName + +#### 详细描述 + + +#### 定义 + +`NewFromProgramName(programName string, opts ...Option) (*Program, error)` + +#### 参数 +|参数名|参数类型|参数解释| +|:-----------|:---------- |:-----------| +| programName | `string` | | +| opts | `...Option` | | + +#### 返回值 +|返回值(顺序)|返回值类型|返回值解释| +|:-----------|:---------- |:-----------| +| r1 | `*Program` | | +| r2 | `error` | | + + ### Parse #### 详细描述 diff --git a/docs/api/syntaxflow.md b/docs/api/syntaxflow.md new file mode 100644 index 000000000..72f4c23ef --- /dev/null +++ b/docs/api/syntaxflow.md @@ -0,0 +1,95 @@ +# syntaxflow + +|函数名|函数描述/介绍| +|:------|:--------| +| [syntaxflow.ExecRule](#execrule) || +| [syntaxflow.QuerySyntaxFlowRules](#querysyntaxflowrules) || +| [syntaxflow.withExecDebug](#withexecdebug) || +| [syntaxflow.withExecTaskID](#withexectaskid) || + + +## 函数定义 +### ExecRule + +#### 详细描述 + + +#### 定义 + +`ExecRule(r *schema.SyntaxFlowRule, prog *ssaapi.Program, opts ...ExecRuleOption) (*ssaapi.SyntaxFlowResult, error)` + +#### 参数 +|参数名|参数类型|参数解释| +|:-----------|:---------- |:-----------| +| r | `*schema.SyntaxFlowRule` | | +| prog | `*ssaapi.Program` | | +| opts | `...ExecRuleOption` | | + +#### 返回值 +|返回值(顺序)|返回值类型|返回值解释| +|:-----------|:---------- |:-----------| +| r1 | `*ssaapi.SyntaxFlowResult` | | +| r2 | `error` | | + + +### QuerySyntaxFlowRules + +#### 详细描述 + + +#### 定义 + +`QuerySyntaxFlowRules(name string, opts ...QueryRulesOption) chan *schema.SyntaxFlowRule` + +#### 参数 +|参数名|参数类型|参数解释| +|:-----------|:---------- |:-----------| +| name | `string` | | +| opts | `...QueryRulesOption` | | + +#### 返回值 +|返回值(顺序)|返回值类型|返回值解释| +|:-----------|:---------- |:-----------| +| r1 | `chan *schema.SyntaxFlowRule` | | + + +### withExecDebug + +#### 详细描述 + + +#### 定义 + +`withExecDebug(debug ...bool) ExecRuleOption` + +#### 参数 +|参数名|参数类型|参数解释| +|:-----------|:---------- |:-----------| +| debug | `...bool` | | + +#### 返回值 +|返回值(顺序)|返回值类型|返回值解释| +|:-----------|:---------- |:-----------| +| r1 | `ExecRuleOption` | | + + +### withExecTaskID + +#### 详细描述 + + +#### 定义 + +`withExecTaskID(taskID string) ExecRuleOption` + +#### 参数 +|参数名|参数类型|参数解释| +|:-----------|:---------- |:-----------| +| taskID | `string` | | + +#### 返回值 +|返回值(顺序)|返回值类型|返回值解释| +|:-----------|:---------- |:-----------| +| r1 | `ExecRuleOption` | | + +