aardio 文档

fsys.codepage 库模块帮助文档

说明

遵循最佳实践:

fsys.codepage 成员列表 #

fsys.codepage.copy(源文件路径,目标文件路径,源编码,目标编码) #

使用 fsys.codepage.load 读取源文件,
再使用 fsys.codepage.save 保存到目标文件。
所有编码参数都可选指定代码页或字符集。
目标编码(写入目标文件的文本编码)默认为 65001(UTF-8 代码页)。

即使显式指定了源编码(源文件的文本编码),
此函数也会检查文件 BOM 以及文件头部字节的编码特征以确定实际编码。
仅在无法确定实际编码时源编码参数才会生效。
如果无法确定实际编码并且未指定源编码参数,
此函数会调用 string.isUtf8 函数以确定文件是否 UTF-8 编码。

fsys.codepage.load("文件路径",源编码,目标编码) #

读取文件并转换源编码为目标编码。
成功则返回读取的字符串,实际使用的源编码;失败返回 null, 错误信息。
参数 @2,@3 都是可选参数。
可自动识别文件编码,并自动转换为目标编码。
所有编码参数都可选指定代码页或字符集。
目标编码(返回字符串的编码)默认为 65001(UTF-8 代码页)。

即使显式指定了源编码(参数 @1 指定文件的文本编码),
此函数也会检查文件 BOM 以及文件头部字节的编码特征以确定实际编码。
仅在无法确定实际编码时源编码参数才会生效。
如果无法确定实际编码并且未指定源编码参数,
此函数会调用 string.isUtf8 函数以确定文件是否 UTF-8 编码。

fsys.codepage.load(文件路径,"ansi") #

读取 ANSI 编码文件
并自动转换为 UTF-8 编码,
返回文件内容,读取内码

fsys.codepage.load(文件路径,"unicode") #

读取 UNICODE(小尾序)编码文件
并自动转换为 UTF-8 编码,
返回文件内容,以及读取内码

fsys.codepage.load(文件路径,"unicodeFFFE") #

读取 UNICODE(大尾序)编码文件
并自动转换为 UTF-8 编码,返回文件内容,以及读取内码,

注意 unicodeFFFE 的 BOM 是 '\xFE\xFF',反过来的!

fsys.codepage.load(文件路径,"utf-8") #

读取 UTF-8 编码文件
并自动转换为 UTF-8 编码,
返回文件内容,读取内码

fsys.codepage.save("文件路径",字符串,输出编码,源编码) #

以指定的文本编码存储参数 @2 指定的字符串(或 buffer)到文件。
所有编码参数都可指定代码页或字符集。
源编码(指定 @str 的文本编码,可选)默认为 65001

fsys.codepage.save(文件路径,str,"ansi") #

将参数 @2 指定的字符串以 ANSI 编码存为文件,参数 @3 指定输出编码(代码页或字符集)
可选以参数 @4 指定输入编码(代码页或字符集),默认为 65001

fsys.codepage.save(文件路径,str,"unicode") #

将参数 @2 指定的字符串存为 UNICODE(小尾序)编码文件,并添加 BOM 编码标识
可选以参数@4指定输入字符集或代码页,默认为65001。

fsys.codepage.save(文件路径,str,"unicodeFFFE") #

将参数 @2 指定的字符串存为UNICODE(大尾序)编码文件,并添加 BOM 编码标识,
注意 unicodeFFFE 的 BOM 是 '\xFE\xFF',反过来的!
可选以参数 @4 指定输入字符集或代码页,默认为 65001。

fsys.codepage.save(文件路径,str,"utf-8") #

将参数 @2 指定的字符串存为 UTF-8 编码文件,不添加 BOM 编码标识。
省略参数 @3 时默认值就是 "utf-8"。
可选以参数 @4 指定输入字符集或代码页,默认为 65001。

fsys.codepage.save(文件路径,str,"utf-8-sig") #

将参数 @2 指定的字符串存为 UTF-8 编码文件,并添加 BOM 编码标识。
可选以参数 @4 指定输入字符集或代码页,默认为 65001。

Markdown 格式