⚡ 配置

默认的 Treasury.toml 文件看起来像这样

是的，一个空文件。

有四个字段可以覆盖。

• artifacts = "<path>"
  

  将覆盖工件目录为相对于 <base> 的指定路径。默认为 <base>/treasury/artifacts

  工件目录是存储所有工件的地方。这可以，不应该 被VCS覆盖。如果路径在存储库内部，则应忽略。如果财库创建工件目录（在存储工件且目录不存在时），它将创建一个包含“*”的 .gitignore 文件。

• external = "<path>"
  

  将覆盖外部目录到指定路径，该路径相对于 <base>。默认为 <base>/treasury/external

  外部目录是存储所有远程资产元数据文件的地方。此目录 应该 在仓库中，并且不应被版本控制系统忽略。

• temp = "<path>"
  

  将覆盖临时文件的默认目录。默认为 std::env::temp_dir() 的结果。临时文件用作下载以供导入器消费的源和导入器输出的中间存储。

• importers = ["<list>", "<of>", "<paths>"]
  

  将告知应为此实例使用哪些导入器库。
  Rust项目的导入器库通常位于cargo工作空间的target目录中。

一旦初始化Treasury实例，就可以用它来存储和检索资产。

⚡ 存储

在Treasury中存储资产很简单。使用CLI命令看起来是这样的

treasury store <source-path> <target-format>

输出中的最后一行将包含 AssetId，如果存储操作成功。否则将打印错误信息。

如果源格式不明确，可以在目标格式之后指定它。

treasury store <source-path> <target-format> <source-format>

要从URL存储资产，请使用 --url（简称 -u）标志。

treasury store --url <source-url> <target-format> <source-format>

没有此标志，源参数始终解释为文件路径。使用此标志，源参数始终解释为URL。这也可以是 file: URL。

使用库API存储时，使用 treasury_client::Client::store_asset 方法。

存储过程

整个过程可以描述为四个步骤

1. 用户提供资产源、最终应用程序将使用的目标格式，以及可选的源格式。只有在不明确时才需要源格式。
2. 运行并处理资产为工件注册的导入器，匹配源和目标格式。
3. Treasury存储生成的工件。它避免存储重复项，但不同的资产可能指向同一个工件。
4. 返回AssetId。

⚡ 检索

用户可以使用资产源和目标格式，或者 AssetId 检索存储资产的工件。工件应始终使用 AssetId。当资产源迁移时，.treasury文件应随之迁移。在这种情况下，不需要重新导入，并且它们的 AssetId 将得到保留。

⚡ 导入器

为了存储资产，需要一个导入器将资产源 🥚 转换为工件 🐤。

导入器是实现 treasury_import::Importer 特性的类型。
Treasury可以配置为从动态库加载导入器。

为了简化编写导入器库并最小化可能由无效实现引起的问题，应使用 treasury_import::make_treasury_importers_library 宏。
此宏将导出服务器预期的所有必要符号。它将确保使用 treasury_import crate的主版本号使用ABI兼容性。该宏及其生成的代码将执行所有不安全操作，将导入器库的作者留有简单且100%安全的Rust。

示例导入器

基本导入器库可能看起来像这样

# Cargo.toml
[package]
name = "my-importer"
version = "0.1.0"
edition = "2021"

[lib]
crate-type = ["cdylib"]

[dependencies]
treasury-import = { path = "../../import" }

//! src/lib.rs
struct MyImporter;

impl treasury_import::Importer for MyImporter {
    fn import(
        &self,
        source: &std::path::Path,
        output: &std::path::Path,
        _sources: &impl treasury_import::Sources,
        _dependencies: &impl treasury_import::Dependencies,
    ) -> Result<(), treasury_import::ImportError> {
        match std::fs::copy(source, output) {
          Ok(_) => Ok(()),
          Err(err) => Err(treasury_import::ImporterError::Other { reason: "SOMETHING WENT WRONG".to_owned() }),
        }
    }
}


// Define all required exports.
treasury_import::make_treasury_importers_library! {
    // [extensions list]  <name> : <source-format> -> <target-format> = <expr>;
    // <expr> must have type &'static I where I: Importer
    // Use `Box::leak(importer)` if importer instance cannot be constructed in constant expression.
    [foo] foo : foo -> foo = &FooImporter;
}

导入过程中产生的工件应始终使用 AssetId 来引用依赖。资产源文件可以包含路径（相对于源文件或绝对路径）或URL，可以通过 Dependencies 容易地转换为 AssetId。如果找不到依赖，应返回 ImportResult::RequireDependencies { ... }。存储过程将尝试存储依赖并重试导入。

缺少什么？

目前，此项目是资产管道的简化实现。

• 打包尚未实现。必须有一种方法将工件子集打包到优化用于磁盘存储和无需间接引用加载的包中。
• 服务器尚未准备好在远程模式下使用。为此，服务器应能够从请求存储操作的客户机获取本地源数据。
• 目前仅支持 file: 和 data: URL。这对于处理本地资产已经足够。
• 🔥 热重载 🔥 尚不可行，因为服务器不监视 👀 源文件的变化。

许可证

许可证为以下之一

• Apache License，版本 2.0，（license/APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT 许可证（license/MIT 或 http://opensource.org/licenses/MIT）

任选其一。

贡献

除非你明确说明，否则，任何有意提交以包含在你通过 Apache-2.0 许可证定义的作品中的贡献，都应按上述方式双许可，没有任何附加条款或条件。