豫豫言文档API ATLAS
入口包说明.html
2 模块69 名称
← 全部模块

模块 / 2

请求。豫

请求。豫

65公开名称

读态

公开
「元类型」

文言:读态者,一答之读势也;表居实例之内,事毕随实例而弃,不越事而存。汉语:每个响应柄对应一条读取状态,表存放在本次事件的 Wasm 实例内,事件结束即随实例消失。字段依次为:响应柄、中断信号号、读取器号、解码器号、余块号、余块偏移、余块总长、结局(零读取中,一已读尽,二读取错误,三超时或已取消)、结局文、待出文字。

读态表

公开
(「引用类」于(「列」于(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)))

暂无说明。

新读态

公开
化「字符串」而化「字符串」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:造新读势,字段皆空。汉语:创建响应柄的初始读取状态:尚无读取器、解码器、余块,结局为读取中。

读态换读器

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「字符串」而化「字符串」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:易读器与解码器之柄。汉语:返回替换了读取器号与解码器号的新状态。

读态换余块

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「字符串」而化「整数」而化「整数」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:易余块之柄、偏移与总长。汉语:返回替换了余块号、余块偏移与余块总长的新状态。

读态换待出

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「字符串」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:易待出之文。汉语:返回替换了待出文字的新状态。

释放非空句柄

公开
化「字符串」而「有」

文言:柄非空则释之。汉语:句柄号非空时释放宿主句柄,空则什么也不做。

终结读态

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而化「字符串」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:结局既定,则释读器、解码器、余块与信号诸柄,以免久占句柄表。汉语:进入终态时释放全部临时宿主句柄,并把结局写入状态。

换读态项

公开
化(「列」于(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」))而化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而(「列」于(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」))

文言:表中同柄者易之,无则增。汉语:在状态表里替换同一响应柄的状态,表中没有则追加。

查读态项

公开
化(「列」于(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」))而化「字符串」而(「爻」合(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」))

文言:按柄查表,得(有无,态)。汉语:按响应柄查状态表,返回(是否找到,状态)。

存读态

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而「有」

文言:书态入表。汉语:把状态写回本次事件的状态表。

登记读态

公开
化「字符串」而化「字符串」而「有」

文言:新答柄入表,并记其信号。汉语:为新签发的响应柄登记初始状态并记下中断信号号(无信号为空串)。

取读态

公开
化「字符串」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:取柄之态;非本包所发者告事故。汉语:取响应柄的状态;不是本事件内由本包签发的柄抛豫言异常。

已开始读取

公开
化「字符串」而「爻」

文言:此柄之答已启增量之读者,不可再整读或转为终答。汉语:判断响应柄是否已开始增量读取(读取器已创建或已有结局);旧的整体读取与原流转发函数据此拒绝,避免对已上锁的流抛出无法捕获的宿主错误。

安全错误文

公开
化「字符串」而「字符串」

文言:宿主抛错之名与文合为一句,供应用记录。汉语:把安全方法调用返回的错误 JSON(名称与消息)合成一句“名称: 消息”。

续字节

公开
化「整数」而「爻」

文言:验 UTF-8 续字节(二进制十开头)。汉语:判断一个字节是否是 UTF-8 的续字节(0x80 至 0xBF)。

码点起点

公开
化「字符串」而化「整数」而「整数」

文言:自位向前求码点之首字节。汉语:从字节位置向前找到所在码点的首字节位置。

数码点首

公开
化「字符串」而化「整数」而化「整数」而化「整数」而「整数」

文言:数止位之前码点首字节之数。汉语:统计字节区间内码点首字节(非续字节)的个数,即码点数。

切文

公开
化「字符串」而化「整数」而(「字符串」合「字符串」)

文言:依字节之限裁文,必断于码点之界,不留半字。汉语:把文字切成不超过给定 UTF-8 字节数的前段和余段,切点落在码点边界,绝不产生被截断的半个字符。

造读器

公开
化「字符串」而化「字符串」而(「爻」合「字符串」)

文言:造读器;有信号则以管道系之。汉语:创建读取器:没有信号时直接取正文流的读取器;有信号时经恒等转换流的管道把信号接到正文流再取读取器。返回(成功,读取器号或错误文)。

开读器

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:初读乃开读器;有信号则以管道系之,使期满则读败而源亦消;无正文者径终。汉语:首次读取时才创建读取器:有中断信号时经恒等转换流的管道把信号接到正文流,超时后读取会失败且上游被取消;没有正文的响应直接进入已读尽状态。

取余块段

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字节串」合「字符串」)

文言:自余块取至多上限字节。汉语:从上次多出的余块中取至多上限个字节;取尽则释放余块。

切原始块

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「字符串」而化「整数」而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字节串」合「字符串」)

文言:上游一块过大则留其余于状态。汉语:把上游一块按上限切开:块不大于上限则整取并释放;否则取前段,余部作为余块留在状态里。

取原始段

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字节串」合「字符串」)

文言:取原字至多上限个;种类零得字,一流终,二读败。汉语:取下一段原始字节,至多上限个;上游一块过大则余部留在状态中。返回:新状态、种类(零得字节,一流已终,二读取失败)、字节、错误文。

读尽收尾

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字符串」合「整数」)

文言:流终则冲解码器之余,定局为一。汉语:流结束时冲刷解码器(残缺序列成 U+FFFD),把状态定为已读尽。

读取失败

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「字符串」而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字符串」合「整数」)

文言:读败则察信号:期满为三,否则为二。汉语:读取失败时检查中断信号:已中断则定为超时(三),否则定为读取错误(二)。

读解码

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而化「整数」而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字符串」合「整数」)

文言:读一段原字而续解之;不成字则再读,至得文、流终、败或时尽。返回:新状态、种类(零得文,一流终,二败,三超时或已消)、文或说明、本次所耗原字数。汉语:读取并流式解码:不足一个完整字符时继续读取,直到得到非空文字、流结束、失败或超时/取消。返回:新状态、种类、文字或说明、本次消耗的原始字节数。

出块

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字符串」)

文言:出块者,先出待出之文,次读上游;文之长逾限则裁而留其余。汉语:按上限出一块文字:先把上次多出的待出文字切出来;没有待出文字时读取上游并解码;解码所得若超过上限,则切出前段并把余段留作待出文字。返回:新状态、种类、文字。

取消读态

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「字符串」而(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)

文言:取消者,经读器(未创读器则径对正文流)对源流行 cancel;幂等,已定局者不再动。汉语:取消响应读取:通过读取器(或尚未创建读取器时直接对正文流)执行 cancel,上游能否观察到取决于平台;幂等,已有结局的状态不变。

全是数字

公开
化「字符串」而化「整数」而化「整数」而「爻」

文言:验文自位至长皆十进制数字。汉语:判断字符串从位置到长度是否全是十进制数字字节。

查声明长度

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而「整数」

文言:观答之 Content-Length;无或坏则负一。汉语:读取响应的 Content-Length:缺失或不是数字返回 -1。

累积有限

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而化「整数」而化(「列」于「字符串」)而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字符串」)

文言:累读至终,不逾上限;逾则取消而告过大。每次至多多读一字,故限内不多取。汉语:循环读取并累计原始字节:超过上限立即取消并返回状态一;流结束则拼接全部文字返回状态零;失败或超时返回二、三。

有限读

公开
化(「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)而化「整数」而((「字符串」合「字符串」合「字符串」合「字符串」合「字符串」合「整数」合「整数」合「整数」合「字符串」合「字符串」)合「整数」合「字符串」)

文言:整读余文而限其字节,结局定则径返。汉语:有限整读:已有错误或取消结局则直接返回;先看声明长度和待出文字,再循环累计。返回(新状态,状态,文字)。

令牌字节

公开
化「整数」而「爻」

文言:验字节是否合 HTTP 令牌。汉语:判断字节是否属于 HTTP 标头令牌字符集(字母、数字与 !#$%&'*+-.^_`|~)。

可见字节

公开
化「整数」而「爻」

文言:验字节为可见 ASCII(空格至波浪号)。汉语:判断字节是否是可见 ASCII 字符(0x20 至 0x7E)。

全字节合

公开
化「字符串」而化「整数」而化「整数」而化化「整数」而「爻」而「爻」

文言:验文自位至长之字节皆合谓词。汉语:判断字符串从位置到长度的每个字节是否都满足给定条件。

标头名合法

公开
化「字符串」而「爻」

文言:标头名须为一至一二八字节之令牌。汉语:标头名须是 1 至 128 字节的合法令牌。

小写字节

公开
化「字符串」而化「整数」而化「整数」而化「字符串」而「字符串」

文言:逐字节转 ASCII 小写。汉语:逐字节把 ASCII 大写字母转成小写并累积。

小写名

公开
化「字符串」而「字符串」

文言:仅施于已验为令牌之名,故字节皆在可见之域。汉语:把已验证为标头令牌的名字转成 ASCII 小写;不能用于含非 ASCII 字节的文字。

已用名

公开
化「字符串」而化(「列」于「字符串」)而「爻」

文言:名已在列则阳。汉语:判断名字是否已在列表中出现。

标头值合法限

公开
化「字符串」而化「整数」而「爻」

文言:头值须可见 ASCII,首尾无空格,长不逾限。汉语:标头值须只含可见 ASCII 字符、首尾不得为空格、长度不超过给定上限。

标头值合法

公开
化「字符串」而「爻」

文言:头值至多五一二字节。汉语:标头值的通用校验:上限 512 字节。

请求编号字节

公开
化「整数」而「爻」

文言:请求 ID 之形,三十六位,惟小写十六进制与短横。汉语:X-Yuyan-Request-ID 的值须恰为 36 个字符,只含小写十六进制数字与连字符。

请求编号合法

公开
化「字符串」而「爻」

文言:请求 ID 须恰三十六字,小写十六进制与短横。汉语:请求编号须恰为 36 个字符,只含小写十六进制数字与连字符。

引文

公开
化「字符串」而「字符串」

暂无说明。

读文

公开
化「字符串」而「字符串」

暂无说明。

读数

公开
化「字符串」而「整数」

暂无说明。

已用头

公开
化「字符串」而化(「列」于「字符串」)而「爻」

暂无说明。

可复制头

公开
化「字符串」而「爻」

暂无说明。

可定头

公开
化「字符串」而「爻」

暂无说明。

复制诸头

公开
化「字符串」而化「字符串」而化(「列」于「字符串」)而化(「列」于「字符串」)而(「列」于「字符串」)

暂无说明。

置诸定头

公开
化「字符串」而化(「列」于(「字符串」合「字符串」))而化(「列」于「字符串」)而「有」

暂无说明。

请求授权服务

公开
化「字符串」而化「字符串」而化「字符串」而化(「列」于「字符串」)而化(「列」于(「字符串」合「字符串」))而化「爻」而「字符串」

暂无说明。

读取授权服务状态

公开
化「字符串」而「整数」

暂无说明。

读取授权服务癸象正文文

公开
化「字符串」而「字符串」

暂无说明。

回应入站以授权服务原答

公开
化「字符串」而「有」

暂无说明。

内部网址字节

公开
化「整数」而「爻」

文言:内请之址,惟 HTTPS 而无凭据,且不含控字、空白与反斜线;非此则败。汉语:校验授权服务内部网址:绝对 HTTPS、无用户名口令、无控制字符空白与反斜线、可被 URL 解析;否则抛事故。

校验授权服务网址

公开
化「字符串」而「有」

文言:内请之址,惟 HTTPS 而无凭据,且不含控字、空白与反斜线;非此则败。汉语:校验授权服务内部网址:绝对 HTTPS、长 1 至 2048 字节、无用户名口令、无控制字符空白与反斜线、可被 URL 解析;违规抛豫言异常。

带正文定头名合法

公开
化「字符串」而「爻」

文言:带正文之请,定头惟 Content-Type、Accept 与 X-Yuyan-*。汉语:带正文请求的固定标头名(已转小写)只允许 content-type、accept 与 x-yuyan- 开头者。

校验带正文定头们

公开
化(「列」于(「字符串」合「字符串」))而化(「列」于「字符串」)而「有」

文言:逐一验定头之名、重、值。汉语:逐项校验固定标头:名是令牌且在白名单、不重复、值合规;违规抛豫言异常。

请求授权服务带正文

公开
化「字符串」而化「字符串」而化「字符串」而化(「列」于(「字符串」合「字符串」))而化「字符串」而化「整数」而(「爻」合「字符串」)

文言:以字节而非 JSON 传正文,故任何字符皆不失;期限覆盖发请至读尽之全程。汉语:向授权服务发带正文的白名单请求。正文以字节句柄传入(不经 JSON 转义),中断信号 AbortSignal.timeout 覆盖发请和读取响应的整个交换;失败或超时返回阴和原因,成功返回阳和仅本次事件有效的响应柄。

读取授权服务响应标头

公开
化「字符串」而化「字符串」而「字符串」

文言:按名取答头,无则空。汉语:读取授权服务响应的指定标头值,不区分大小写;缺失返回空字符串。名须是合法标头令牌。

读取授权服务响应块

公开
化「字符串」而化「整数」而(「整数」合「字符串」)

文言:逐块取文,跨块之字自相衔接;一至六万五千五百三十六字节为限。状态零得文,一流终,二读败,三超时或已消。汉语:增量读取响应正文的下一块文字。宿主做流式 UTF-8 解码,跨块多字节字符正确拼接,非法序列成 U+FFFD,返回的文字不含被截断的半个字符,UTF-8 字节数不超过最大字节(最大字节小于 4 按 4 计)。状态:0 数据块,1 流结束(文字为空),2 读取错误(文字为原因),3 超时或已取消。

读取授权服务响应有限文字

公开
化「字符串」而化「整数」而(「整数」合「字符串」)

文言:整读余文,逾限则弃而告过大;先验其声明之长,不逾乃读。汉语:一次读完响应剩余正文并返回文字:状态 0 成功,1 超过字节上限(先看 Content-Length,超限不读;流式累计超限则取消),2 错误,3 超时或已取消。字节上限 1 至 8388608。

取消授权服务响应

公开
化「字符串」而「有」

文言:取消则对源流行 cancel,幂等。汉语:取消对响应的读取并对上游流执行取消;重复调用无害。