Engee 文档

用于处理文件系统和扩展名的类(UTILS_API)

页面进行中。

*UTILS_API*是一组用于处理用户计算机上的文件和目录的辅助方法，不适用于*Engee*目录。

使用*UTILS_API*您可以:

  • 上传文件到您的计算机;

  • 从计算机下载文件;

  • 使用指定的路径在文件系统中创建和删除目录。

此外，*UTILS_API*允许您将外部用户模块连接到*Engee*硬件支持包。 访问模块后立即打开 安装支持包。

function createFile(utils::Any, filename::String, filepath::String, contents::Union{Vector{UInt8}, String, Nothing}=nothing, mode::String="wb", buffering::Int64=-1, encoding::Union{String, Nothing}=nothing, errors::Union{String, Nothing}=nothing, newline::Union{String, Nothing}=nothing, closefd::Bool=true)::Nothing

该函数旨在在指定目录filepath中创建用户客户端程序上名为filename的文件。

参数

  • utils:对象类型 UTILS.Utils.

  • engee_filepath：文件浏览器目录中的文件路径Engee。

  • host_dirpath：将从Engee上载指定文件的用户客户端程序目录的路径。

  • mode：文件打开模式。 可能的值:

  • "r":阅读;

  • "w"：录音（复盖）;

  • "a":额外录音;

  • "wb":二进制符号;

  • "rb"：二进制读取。

  • buffering：用于处理文件的系统缓冲区的参数。 可能的值:

  • -1：默认系统缓冲区;

  • 0：禁用缓冲;

  • 1：逐行缓冲（仅在文本模式下）;

  • >1：以字节为单位的缓冲区大小。

  • encoding：文件的编码。 可能的值: "utf-8", "cp1251", "ascii", "latin-1", nothing -默认系统设置。

  • errors:错误处理策略:

  • "strict"：非编码字符的错误;

  • "ignore"：忽略非编码字符;

  • "replace"：替换为 � (替换标记);

  • "backslashreplace"：替换为转义序列。

  • newline:线进给控制:

  • nothing 或 "" -通用模式;

  • "\n", "\r", "\r\n" -特定的换行选项。 换行符因系统而异:

-Unix/Linux: \n; -窗户: \r\n; -旧的MacOS: \r.

  • closefd:自动关闭文件描述符(true -关闭它, false -让它打开）。

  • filename:正在创建的文件的名称;

  • filepath:创建文件的目录路径;

  • contents：文件内容（字符串、字节或 nothing).

function createFolder(utils::Any, folder_path::String, folder_name::String, mode::Int64=511, dir_fd::Union{Int64, Nothing}=nothing)::Nothing

该函数旨在在指定目录folder_path中创建用户客户端程序上名为folder_name的目录。

参数

  • utils:对象类型 UTILS.Utils.

  • folder_path：将创建新文件夹的用户客户端程序上的目录的路径。

  • folder_name:正在创建的目录的名称。

  • mode：目录的访问模式。 访问权限示例:

    /权利/八进制/十进制/描述

    -----------

    --------------

    ------------

    ----------------------------------------------------

    rwxrwxrwx

    0o777

    511/所有人的完全访问

    rwxr-xr-x

    0o755

    493/目录的标准权利

    rwxr-x---

    0o750

    488/所有者：完全访问权限，组：读取+执行

    /rwx------

    0o700

    448

    仅限业主

    rw-rw-rw-

    0o666

    438/读+写所有

    rw-r—​r--/0o644/420/标准文件权限

    rw-r-----

    0o640

    416/所有者：读+写，组：读

    /rw-------

    0o600

    384/仅限所有者（读+写）

  • dir_fd：文件描述符。 nothing -通常的路径，数字是通过描述符的相对路径。

function deleteExtension(utils::Any, path_to_extension::String)::Nothing

该功能旨在从自动上传到Engee硬件支持包中删除指定的用户扩展路径。

参数

  • utils:对象类型 UTILS.Utils.

  • path_to_extension：正在删除的扩展名的路径。

function deleteFile(utils::Any, filename::String, filepath::String, ignore_if_missing::Bool=false, verbose::Bool=false)::Nothing

该函数旨在删除指定目录filepath中用户客户端程序上名为filename的文件。

参数

  • utils:对象类型 UTILS.Utils.

  • filename：要删除的文件的名称。

  • filepath：要删除文件的目录的路径。

  • ignore_if_missing: false -错误，如果文件没有找到; true -忽略丢失的文件。

  • verbose:输出操作详情(true）或不（false).

function deleteFolder(utils::Any, folder_path::String, folder_name::String, even_if_not_empty::Bool=false, dir_fd::Union{Int64, Nothing}=nothing)

该函数旨在删除指定目录folder_path中用户客户端程序上名为folder_name的目录。

参数

  • utils:对象类型 UTILS.Utils.

  • folder_path：用户客户端程序上的目录的路径。

  • folder_name：要删除的目录的名称。

  • even_if_not_empty：删除即使目录不为空（true -是的, false：只有空的）。

  • dir_fd:文件描述符: nothing -通常的路径，数字是使用相对路径。

function downloadFile(utils::Any, engee_dirpath::String, host_filepath::String, mode::String="rb", buffering::Int64=-1, encoding::Union{String, Nothing}=nothing, errors::Union{String, Nothing}=nothing, newline::Union{String, Nothing}=nothing, closefd::Bool=true)::Nothing

该功能旨在将指定文件从用户的客户端程序下载到Engee文件浏览器的指定目录。

参数

  • utils:对象类型 UTILS.Utils.

  • engee_filepath：文件浏览器目录中的文件路径Engee。

  • host_dirpath：将从Engee上载指定文件的用户客户端程序目录的路径。

  • mode：文件打开模式。 可能的值:

  • "r":阅读;

  • "w"：录音（复盖）;

  • "a":额外录音;

  • "wb":二进制符号;

  • "rb"：二进制读取。

  • buffering：用于处理文件的系统缓冲区的参数。 可能的值:

  • -1：默认系统缓冲区;

  • 0：禁用缓冲;

  • 1：逐行缓冲（仅在文本模式下）;

  • >1：以字节为单位的缓冲区大小。

  • encoding：文件的编码。 可能的值: "utf-8", "cp1251", "ascii", "latin-1", nothing -默认系统设置。

  • errors:错误处理策略:

  • "strict"：非编码字符的错误;

  • "ignore"：忽略非编码字符;

  • "replace"：替换为 � (替换标记);

  • "backslashreplace"：替换为转义序列。

  • newline:线进给控制:

  • nothing 或 "" -通用模式;

  • "\n", "\r", "\r\n" -特定的换行选项。 换行符因系统而异:

-Unix/Linux: \n; -窗户: \r\n; -旧的MacOS: \r.

  • closefd:自动关闭文件描述符(true -关闭它, false -让它打开）。

function loadExtension(utils::Any, path_to_extension::String)::Nothing

该功能旨在将自定义扩展下载到Engee硬件支持包。

参数

  • utils:对象类型 UTILS.Utils.

  • path_to_extension：下载扩展的路径。

function uploadFile(utils::Any, engee_filepath::String, host_dirpath::String, mode::String="wb", buffering::Int64=-1, encoding::Union{String, Nothing}=nothing, errors::Union{String, Nothing}=nothing, newline::Union{String, Nothing}=nothing, closefd::Bool=true)::Nothing

该功能旨在将指定文件从Engee文件浏览器下载到指定目录中的用户客户端程序。

参数

  • utils:对象类型 UTILS.Utils.

  • engee_filepath：文件浏览器目录中的文件路径Engee。

  • host_dirpath：将从Engee上载指定文件的用户客户端程序目录的路径。

  • mode：文件打开模式。 可能的值:

  • "r":阅读;

  • "w"：录音（复盖）;

  • "a":额外录音;

  • "wb":二进制符号;

  • "rb"：二进制读取。

  • buffering：用于处理文件的系统缓冲区的参数。 可能的值:

  • -1：默认系统缓冲区;

  • 0：禁用缓冲;

  • 1：逐行缓冲（仅在文本模式下）;

  • >1：以字节为单位的缓冲区大小。

  • encoding：文件的编码。 可能的值: "utf-8", "cp1251", "ascii", "latin-1", nothing -默认系统设置。

  • errors:错误处理策略:

  • "strict"：非编码字符的错误;

  • "ignore"：忽略非编码字符;

  • "replace"：替换为 � (替换标记);

  • "backslashreplace"：替换为转义序列。

  • newline:线进给控制:

  • nothing 或 "" -通用模式;

  • "\n", "\r", "\r\n" -特定的换行选项。 换行符因系统而异:

-Unix/Linux: \n; -窗户: \r\n; -旧的MacOS: \r.

  • closefd:自动关闭文件描述符(true -关闭它, false -让它打开）。