开源项目 `either` 使用教程

开源项目 either 使用教程

eitherThe enum Either with variants Left and Right is a general purpose sum type with two cases.项目地址:https://gitcode.com/gh_mirrors/eit/either

1. 项目的目录结构及介绍

either/
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── src/
│   ├── either.rs
│   ├── lib.rs
│   └── macros.rs
└── tests/
    └── either.rs

• Cargo.toml: 项目的依赖和元数据配置文件。
• LICENSE-APACHE 和 LICENSE-MIT: 项目的开源许可证文件。
• README.md: 项目的基本介绍和使用说明。
• src/: 包含项目的源代码文件。
  • either.rs: 定义了 Either 枚举类型及其方法。
  • lib.rs: 项目的入口文件，负责模块的导入和导出。
  • macros.rs: 包含一些宏定义。
• tests/: 包含项目的测试代码。
  • either.rs: 针对 Either 枚举类型的测试代码。

2. 项目的启动文件介绍

项目的启动文件是 src/lib.rs，它负责导入和导出项目的各个模块。以下是 src/lib.rs 的主要内容：

pub use either::Either;

mod either;
mod macros;

• pub use either::Either;: 导出 Either 枚举类型，使其可以在项目外部使用。
• mod either;: 导入 either.rs 模块。
• mod macros;: 导入 macros.rs 模块。

3. 项目的配置文件介绍

项目的配置文件是 Cargo.toml，它包含了项目的依赖、元数据和其他配置信息。以下是 Cargo.toml 的主要内容：

[package]
name = "either"
version = "1.6.1"
authors = ["bluss"]
edition = "2018"
license = "MIT OR Apache-2.0"
description = "The enum `Either` with values `Left` and `Right` is a general-purpose sum type with two cases."
repository = "https://github.com/bluss/either"
readme = "README.md"
keywords = ["enum", "either", "sum-type"]
categories = ["data-structures"]

[dependencies]

• [package]: 包含项目的基本信息，如名称、版本、作者、许可证等。
• [dependencies]: 列出了项目所依赖的其他库，但在这个项目中，没有外部依赖。

以上是开源项目 either 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

eitherThe enum Either with variants Left and Right is a general purpose sum type with two cases.项目地址:https://gitcode.com/gh_mirrors/eit/either