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

模块 / 2

对象。豫

对象。豫

74公开名称

键上限字节

公开
「整数」

文言:诸限皆书于此,宿主值桥之限为一千六百万字节。汉语:适配强制的各项上限:键 1024 字节、正文 16 MiB、文字读取上限 2 MiB(JSON 转义最坏六倍仍低于值桥 16 MiB)、删除 1000 个、列举 1000 个、附加标头 64 项。

正文上限字节

公开
「整数」

暂无说明。

文字读取上限

公开
「整数」

暂无说明。

引文

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

暂无说明。

全字节合格

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

文言:逐字节验,全合乃阳;合之术由客授。汉语:从第 位 个字节起逐字节检查,全部满足给定判断才返回阳,只做整数比较,不分配。

串全字节合格

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

暂无说明。

非控制字节

公开
化「整数」而「爻」

暂无说明。

可见ASCII字节

公开
化「整数」而「爻」

暂无说明。

数字字节

公开
化「整数」而「爻」

暂无说明。

字母字节

公开
化「整数」而「爻」

暂无说明。

桶名字节

公开
化「整数」而「爻」

暂无说明。

小写十六字节

公开
化「整数」而「爻」

暂无说明。

标记特殊字节

公开
化「整数」而「爻」

暂无说明。

标记字节

公开
化「整数」而「爻」

暂无说明。

桶名合法

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

文言:桶名即绑定名:一至六十四字节,字母或下划线始,余为字母数字下划线。汉语:桶名是应用传入的绑定名,1 至 64 字节,首字节为字母或下划线,其余为字母、数字或下划线;是否获授权由宿主许可另核。

校桶

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

暂无说明。

键合法

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

文言:键一至一零二四字节,无控制字符,不以斜杠始。汉语:对象键 1 至 1024 字节,不含控制字符(含 NUL),不以斜杠开头;比 R2 更严,使日志、标头与 JSON 不受控制字符牵连。

校键

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

暂无说明。

平台错误消息

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

文言:宿主拒绝则以其原文致事故。汉语:用安全方法调用,把宿主的同步或异步错误转成豫言异常,异常消息保留平台报告的原文(如 R2 的错误码文字)。

安全调用

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

暂无说明。

取对象柄

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

文言:得对象之柄,无则空文。汉语:安全调用桶的方法并返回结果对象的句柄号;宿主返回 null 时返回空字符串。

整数文

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

暂无说明。

读整数属性

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

暂无说明。

读字面属性

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

文言:串属性以其 JSON 字面原样传出,不解不再书,控制字符由宿主已转义。汉语:读取字符串属性并返回宿主给出的 JSON 字符串字面(含引号),不在豫言里解码再编码,避免依赖豫言的转义实现。

读象属性文

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

文言:对象属性若为象则原样传出,缺则空象。汉语:读取对象属性的 JSON;是 JSON 对象时原样返回,缺失或不是对象时返回 {}。

读上传毫秒

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

文言:上传时为日期物,取其毫秒。汉语:R2 的 uploaded 是 Date 对象句柄,调用 getTime 取毫秒后释放句柄。

元字段

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

文言:httpMetadata 惟取五个文字段与到期毫秒,余不传。汉语:从 httpMetadata 取 contentType、contentLanguage、contentDisposition、contentEncoding、cacheControl 五个字符串字段,以及 cacheExpiry(Date 转毫秒整数);字段缺失则略去。

到期字段

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

暂无说明。

读元数据文

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

暂无说明。

对象元数据文

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

文言:一物之元:大小、etag、httpEtag、上传毫秒、httpMetadata、customMetadata。汉语:拼出对象元数据 JSON。

取对象元数据

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

暂无说明。

列含名

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

文言:字符串列之含否,用于选项字段之校。汉语:判断字符串列表是否含某个字符串。

名列无重复

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

暂无说明。

首个未知名

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

暂无说明。

解析选项对象

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

文言:选项为 JSON 象;空文与 null 皆视为无选项,坏 JSON 则告事故。汉语:解析选项 JSON 文字;空字符串与 null 表示没有选项;不是 JSON 对象或无法解析时抛出豫言异常。

校选项名

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

暂无说明。

取文字选项

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

文言:取选项之文字段,返其有无与值;型不合则告事故。汉语:读取选项对象的字符串字段,返回(是否存在,值);存在但不是字符串时抛出豫言异常。

etag字节

公开
化「整数」而「爻」

暂无说明。

etag引用合法

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

文言:etag 引用为双引号包一至六十四个字母数字或连字符。汉语:If-Match 的值必须是 R2 httpEtag 形态:双引号包住 1 至 64 个字母、数字或连字符,不接受星号、弱校验或列表。

允许写入选项名

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

文言:写选项所许之名。汉语:写入选项允许的字段名;出现其他字段一律拒绝。

宿主桥保留名

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

暂无说明。

自定值合法

公开
化「癸象」而「爻」

暂无说明。

自定项合法

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

暂无说明。

校自定元数据

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

文言:customMetadata 至多六十四项,键、值皆文,无控制字符,键不与宿主桥保留名相冲。汉语:校验自定义元数据:至多 64 项,键 1 至 128 字节,值不超过 1024 字节的字符串,均不含控制字符;键不得是宿主值桥的保留名($句柄、$未定义、$大整数、$数字),以免被桥当作句柄引用。

造条件标头

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

文言:视选项定 If-Match 或 If-None-Match 之标头,柄空则无条件。汉语:按条件字段构造 R2 需要的 Headers 对象句柄(onlyIf 必须是真正的 Headers,普通对象会被 R2 静默忽略);没有条件时返回空字符串。

校文字选项

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

暂无说明。

十六摘要合法

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

暂无说明。

造写选项

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

文言:由选项文造宿主选项文与条件标头柄。汉语:解析并校验写入选项,返回(宿主 put 选项 JSON,条件 Headers 句柄或空串);任何未知字段、类型或取值不合都抛出豫言异常。

写入结果文

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

文言:写入结果之 JSON:大小、etag、httpEtag。汉语:拼出成功写入的结果 JSON。

写入对象

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

文言:写字节于对象;条件不合返 written 阴;摘要不符、超限或平台故障皆告事故。汉语:校验桶、键、选项与正文大小后调用 R2 put;onlyIf 用真正的 Headers;put 返回 null(前置条件不满足)时返回 {"written":false} 而不抛异常;其他失败抛出豫言异常并保留平台原文。

写入对象文字

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

文言:文字之字节即其 UTF-8。汉语:把字符串按其 UTF-8 字节写入,规则同写入对象。

读正文字面

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

文言:严格解 UTF-8 之字面,非法则告事故。汉语:读取整个正文,用 fatal 与 ignoreBOM 的 TextDecoder 严格解码,返回宿主给出的 JSON 字符串字面(含引号,不再由豫言转义);非法 UTF-8 抛出豫言异常。

读取对象文字

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

暂无说明。

读取对象字节

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

文言:读对象之全部字节;无则示阴,逾限则告事故。 汉语:读取对象正文为字节串:不存在得(阴,空字节串);存在且大小不超过字节上限得(阳,正文字节);字节上限须在 1 至 16777216 之间;对象大于上限时不读取正文并抛出豫言异常。字节经值桥以二进制传递,不经 JSON 转义。

全校键

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

暂无说明。

删除对象

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

暂无说明。

允许列举选项名

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

文言:列举选项所许之名。汉语:列举选项允许的字段名。

校列举文字选项

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

暂无说明。

列举限额

公开
化「癸象」而「整数」

暂无说明。

列举含自定

公开
化「癸象」而「爻」

暂无说明。

造列举选项

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

文言:造列举之宿主选项文。汉语:按已校验的字段拼出 R2 list 的选项 JSON,limit 总是显式给出。

列举项文

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

暂无说明。

列举诸项

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

暂无说明。

列举对象

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

暂无说明。

标头名合法

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

文言:标头名为 RFC 9110 之标记,字节须在其字符集中。汉语:标头名必须是非空的 HTTP token(字母、数字及 !#$%&'*+-.^_`|~),至多 128 字节。

标头值合法

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

暂无说明。

小写名

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

文言:名之小写形,用于不分大小写之较。汉语:把已通过 token 校验的标头名转成小写 ASCII,用于忽略大小写的比较与禁用名判断。

禁用响应头

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

文言:此类头由平台或本函自定,或涉及连接与帧,客不得给。汉语:禁止应用给出的响应标头:Content-Length、Transfer-Encoding、Connection、Keep-Alive、Upgrade、TE、Trailer、Proxy-Authenticate、Proxy-Authorization、Proxy-Connection、Set-Cookie、ETag(前二者与 ETag 由函数按对象设定)。

校附加标头递归

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

暂无说明。

校附加标头

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

暂无说明。

校响应状态

公开
化「整数」而「有」

暂无说明。

叠加标头

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

暂无说明。

造直通标头

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

文言:先设长度与 etag,后叠客之附加标头。汉语:新建 Headers,先按对象设置 Content-Length 与 ETag,再叠加已校验的附加标头,返回句柄。

回应入站以对象存储对象

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

文言:以对象之流为终答;无对象返阴;HEAD 用 head,无体。汉语:把对象存储对象直通为当前入站请求的最终响应:GET 等方法读取对象并把其 body 流直接交给 Response,不进入豫言内存;HEAD 只读元数据,响应无正文但带 Content-Length 与 ETag;对象不存在时返回阴且不设置响应,应用可继续应答。