Rust Git Version 项目使用教程

Rust Git Version 项目使用教程

rust-git-versionCompile the Git version (tag name, or hash otherwise) and dirty state into your Rust program.项目地址:https://gitcode.com/gh_mirrors/ru/rust-git-version

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

rust-git-version/
├── .github/
│   └── workflows/
│       └── git-version-macro
├── COPYING
├── Cargo.toml
├── README.md
├── rustfmt.toml
└── src/
    └── lib.rs

• .github/workflows/: 包含GitHub Actions的工作流配置文件。
• COPYING: 项目的许可证文件，采用BSD-2-Clause许可证。
• Cargo.toml: 项目的依赖和元数据配置文件。
• README.md: 项目的基本介绍和使用说明。
• rustfmt.toml: Rust代码格式化配置文件。
• src/lib.rs: 项目的主要源代码文件。

2. 项目的启动文件介绍

项目的启动文件是 src/lib.rs，它包含了主要的宏定义和功能实现。以下是文件的主要内容：

// src/lib.rs

#[macro_use]
extern crate proc_macro;

use proc_macro::TokenStream;
use std::process::Command;

#[proc_macro]
pub fn git_version(_: TokenStream) -> TokenStream {
    let output = Command::new("git")
        .args(&["describe", "--always", "--dirty=-modified"])
        .output()
        .unwrap();
    let version = String::from_utf8(output.stdout).unwrap();
    format!("\"{}\"", version.trim()).parse().unwrap()
}

该文件定义了一个名为 git_version 的宏，用于在编译时获取Git版本信息。

3. 项目的配置文件介绍

Cargo.toml

Cargo.toml 是Rust项目的依赖和元数据配置文件。以下是该文件的主要内容：

[package]
name = "rust-git-version"
version = "0.1.0"
edition = "2018"

[dependencies]

[lib]
name = "git_version"
path = "src/lib.rs"

[[bin]]
name = "git-version-example"
path = "src/main.rs"

• [package]: 定义了项目的名称、版本和Rust版本。
• [dependencies]: 定义了项目的依赖。
• [lib]: 定义了库的名称和路径。
• [[bin]]: 定义了可执行文件的名称和路径。

rustfmt.toml

rustfmt.toml 是Rust代码格式化配置文件。以下是该文件的一个示例：

max_width = 100
tab_spaces = 4

该文件定义了代码的最大宽度为100个字符，并且使用4个空格作为制表符。

通过以上介绍，您应该对 rust-git-version 项目有了基本的了解，并能够开始使用和配置该项目。

rust-git-versionCompile the Git version (tag name, or hash otherwise) and dirty state into your Rust program.项目地址:https://gitcode.com/gh_mirrors/ru/rust-git-version