创业初期要建立公司的网站吗,手机网站内容规划,布吉个人网站建设,电商培训心得体会文章目录 包和模块包 CrateRust 的标准目录结构 模块 Module用路径引用模块使用super引用模块使用self引用模块结构体和枚举的可见性 使用 use 引入模块及受限可见性基本引入方式绝对路径引入模块相对路径引入模块中的函数 避免同名引用 注释和文档文档注释包和模块级别的注释注… 文章目录 包和模块包 CrateRust 的标准目录结构 模块 Module用路径引用模块使用super引用模块使用self引用模块结构体和枚举的可见性 使用 use 引入模块及受限可见性基本引入方式绝对路径引入模块相对路径引入模块中的函数 避免同名引用 注释和文档文档注释包和模块级别的注释注释的一个例子 格式化输出对齐精度进制 包和模块
Rust 提供了相应概念用于代码的组织管理
项目(Packages)一个 Cargo 提供的 feature可以用来构建、测试和分享包包(Crate)一个由多个模块组成的树形结构可以作为三方库进行分发也可以生成可执行文件进行运行模块(Module)可以一个文件多个模块也可以一个文件一个模块模块可以被认为是真实项目中的代码组织单元工作空间(WorkSpace)对于大型项目可以进一步将多个包联合在一起组织成工作空间
包 Crate
对于 Rust 而言包是一个独立的可编译单元它编译后会生成一个可执行文件或者一个库。
由于 Package 就是一个项目因此它包含有独立的 Cargo.toml 文件以及因为功能性被组织在一起的一个或多个包。一个 Package 只能包含一个库(library)类型的包但是可以包含多个二进制可执行类型的包。
创建一个二进制 Package
$ cargo new my-projectCreated binary (application) my-project package
$ ls my-project
Cargo.toml
src
$ ls my-project/src
main.rs这里Cargo 创建了一个名称是 my-project 的 Package同时在其中创建了 Cargo.toml 文件可以看一下该文件里面并没有提到 src/main.rs 作为程序的入口原因是 Cargo 有一个惯例src/main.rs 是二进制包的根文件该二进制包的包名跟所属 Package 相同在这里都是 my-project所有的代码执行都从该文件中的 fn main() 函数开始。
使用 cargo run 可以运行该项目输出Hello, world!。
再来创建一个库类型的 Package
$ cargo new my-lib --libCreated library my-lib package
$ ls my-lib
Cargo.toml
src
$ ls my-lib/src
lib.rs首先如果你试图运行 my-lib会报错
$ cargo run
error: a bin target must be available for cargo run原因是库类型的 Package 只能作为三方库被其它项目引用而不能独立运行只有之前的二进制 Package 才可以运行。
Rust 的标准目录结构
一个真实项目中典型的 Package会包含多个二进制包这些包文件被放在 src/bin 目录下每一个文件都是独立的二进制包同时也会包含一个库包该包只能存在一个 src/lib.rs
.
├── Cargo.toml
├── Cargo.lock
├── src
│ ├── main.rs
│ ├── lib.rs
│ └── bin
│ └── main1.rs
│ └── main2.rs
├── tests
│ └── some_integration_tests.rs
├── benches
│ └── simple_bench.rs
└── examples└── simple_example.rs唯一库包src/lib.rs默认二进制包src/main.rs编译后生成的可执行文件与 Package 同名其余二进制包src/bin/main1.rs 和 src/bin/main2.rs它们会分别生成一个文件同名的二进制可执行文件集成测试文件tests 目录下基准性能测试 benchmark 文件benches 目录下项目示例examples 目录下
模块 Module
模块是Rust的代码构成单元。使用模块可以将包中的代码按照功能性进行重组最终实现更好的可读性及易用性。同时我们还能非常灵活地去控制代码的可见性进一步强化 Rust 的安全性。
使用 mod 关键字来创建新模块后面紧跟着模块名称模块可以嵌套这里嵌套的原因是招待客人和服务都发生在前厅因此我们的代码模拟了真实场景模块中可以定义各种 Rust 类型例如函数、结构体、枚举、特征等所有模块均定义在同一个文件中
用路径引用模块
两种引用模块的路径
绝对路径从包根开始路径名以包名或者 crate 作为开头相对路径从当前模块开始以 selfsuper 或当前模块的标识符作为开头
Rust 出于安全的考虑默认情况下所有的类型都是私有化的包括函数、方法、结构体、枚举、常量就连模块本身也是私有化的。父模块完全无法访问子模块中的私有项但是子模块却可以访问父模块、父父…模块的私有项。
Rust 提供了 pub 关键字通过它可以控制模块和模块中指定项的可见性。
使用super引用模块
super 代表的是父模块为开始的引用方式非常类似于文件系统中的 .. 语法
fn serve_order() {}mod back_of_house {fn fix_incorrect_order() {cook_order();super::serve_order();}fn cook_order() {}
}使用self引用模块
self 其实就是引用自身模块中的项也就是说和我们之前章节的代码类似都调用同一模块中的内容
结构体和枚举的可见性
结构体和枚举成员字段拥有完全不同的可见性
将结构体设置为 pub但它的所有字段依然是私有的将枚举设置为 pub它的所有字段也将对外可见
使用 use 引入模块及受限可见性
在 Rust 中可以使用 use 关键字把路径提前引入到当前作用域中随后的调用就可以省略该路径极大地简化了代码。
基本引入方式
在 Rust 中引入模块中的项有两种方式绝对路径和相对路径
绝对路径引入模块
mod front_of_house {pub mod hosting {pub fn add_to_waitlist() {}}
}use crate::front_of_house::hosting;pub fn eat_at_restaurant() {hosting::add_to_waitlist();hosting::add_to_waitlist();
}相对路径引入模块中的函数
在下面代码中我们不仅要使用相对路径进行引入而且与上面引入 hosting 模块不同直接引入该模块中的 add_to_waitlist 函数
mod front_of_house {pub mod hosting {pub fn add_to_waitlist() {}}
}use front_of_house::hosting::add_to_waitlist;pub fn eat_at_restaurant() {add_to_waitlist();add_to_waitlist();
}从使用简洁性来说引入函数自然是更甚一筹但是在某些时候引入模块会更好
需要引入同一个模块的多个函数作用域中存在同名函数
在以上两种情况中使用 use front_of_house::hosting 引入模块要比 use front_of_house::hosting::add_to_waitlist; 引入函数更好。
例如如果想使用 HashMap那么直接引入该结构体是比引入模块更好的选择因为在 collections 模块中我们只需要使用一个 HashMap 结构体
use std::collections::HashMap;fn main() {let mut map HashMap::new();map.insert(1, 2);
}其实严格来说对于引用方式并没有需要遵守的惯例不过建议优先使用最细粒度(引入函数、结构体等)的引用方式如果引起了某种麻烦(例如前面两种情况)再使用引入模块的方式。
避免同名引用
避免同名冲突的关键就是使用父模块的方式来调用除此之外还可以通过as给予引入的项起一个别名它可以赋予引入项一个全新的名称
use std::fmt::Result;
use std::io::Result as IoResult;fn function1() - Result {// --snip--
}fn function2() - IoResult() {// --snip--
}当外部的模块项 A 被引入到当前模块中时它的可见性自动被设置为私有的如果你希望允许其它外部代码引用我们的模块项 A那么可以对它使用pub use进行再导出use 代表引入模块到当前作用域pub 表示将该引入的内容再度设置为可见。
注释和文档
在 Rust 中注释分为三类
代码注释用于说明某一块代码的功能读者往往是同一个项目的协作开发者文档注释支持 Markdown对项目描述、公共 API 等用户关心的功能进行介绍同时还能提供示例代码目标读者往往是想要了解你项目的人包和模块注释严格来说这也是文档注释中的一种它主要用于说明当前包和模块的功能方便用户迅速了解一个项目
代码注释行注释//块注释/* ...... */
文档注释
Rust 提供了 cargo doc 的命令可以用于把这些文档注释转换成 HTML 网页文件最终展示给用户浏览这样用户就知道这个包是做什么的以及该如何使用。
文档行注释///和文档块注释/** ...... */
注意
文档注释需要位于 lib 类型的包中例如 src/lib.rs 中文档注释可以使用 markdown语法例如 # Examples 的标题以及代码块高亮被注释的对象需要使用 pub 对外可见记住文档注释是给用户看的内部实现细节不应该被暴露出去
运行 cargo doc 可以直接生成 HTML 文件放入target/doc目录下。使用 cargo doc --open 命令可以在生成文档后自动在浏览器中打开网页。
常用文档标题
Panics函数可能会出现的异常状况这样调用函数的人就可以提前规避Errors描述可能出现的错误及什么情况会导致错误有助于调用者针对不同的错误采取不同的处理方式Safety如果函数使用 unsafe 代码那么调用者就需要注意一些使用条件以确保 unsafe 代码块的正常工作
包和模块级别的注释
可以给包和模块添加注释需要注意的是这些注释要添加到包、模块的最上方。包级别的注释也分为两种行注释 //! 和块注释 /*! ... */。
注释的一个例子
这个例子我们将重点应用几个知识点
文档注释一个项目可以包含两个包二进制可执行包和 lib 包库包它们的包根分别是 src/main.rs 和 src/lib.rs在二进制包中引用 lib 包使用 pub use 再导出 API并观察文档
首先使用 cargo new art 创建一个 Package art
Created binary (application) art package系统提示我们创建了一个二进制 Package该 Package 包含一个同名的二进制包包名为 art包根为 src/main.rs该包可以编译成二进制然后运行。
现在在 src 目录下创建一个 lib.rs 文件创建该文件等于又创建了一个库类型的包包名也是 art包根为 src/lib.rs该包是是库类型的因此往往作为依赖库被引入。
将以下内容添加到 src/lib.rs 中
//! # Art
//!
//! 未来的艺术建模库现在的调色库pub use self::kinds::PrimaryColor;
pub use self::kinds::SecondaryColor;
pub use self::utils::mix;pub mod kinds {//! 定义颜色的类型/// 主色pub enum PrimaryColor {Red,Yellow,Blue,}/// 副色#[derive(Debug,PartialEq)]pub enum SecondaryColor {Orange,Green,Purple,}
}pub mod utils {//! 实用工具目前只实现了调色板use crate::kinds::*;/// 将两种主色调成副色/// rust/// use art::utils::mix;/// use art::kinds::{PrimaryColor,SecondaryColor};/// assert!(matches!(mix(PrimaryColor::Yellow, PrimaryColor::Blue), SecondaryColor::Green));/// pub fn mix(c1: PrimaryColor, c2: PrimaryColor) - SecondaryColor {SecondaryColor::Green}
}在库包的包根 src/lib.rs 下我们又定义了几个子模块同时将子模块中的三个项通过 pub use 进行了再导出。
接着将下面内容添加到 src/main.rs 中
use art::kinds::PrimaryColor;
use art::utils::mix;fn main() {let blue PrimaryColor::Blue;let yellow PrimaryColor::Yellow;println!({:?},mix(blue, yellow));
}在二进制可执行包的包根 src/main.rs 下我们引入了库包 art 中的模块项同时使用 main 函数作为程序的入口该二进制包可以使用 cargo run 运行
Green至此库包完美提供了用于调色的 API二进制包引入这些 API 完美的实现了调色并打印输出。
最后再来看看文档长啥样
格式化输出
先来一段代码看看格式化输出的初印象
println!(Hello); // Hello
println!(Hello, {}!, world); // Hello, world!
println!(The number is {}, 1); // The number is 1
println!({:?}, (3, 4)); // (3, 4)
println!({value}, value4); // 4
println!({} {}, 1, 2); // 1 2
println!({:04}, 42); // 0042 with leading zeros可以看到 println! 宏接受的是可变参数第一个参数是一个字符串常量它表示最终输出字符串的格式包含其中形如 {} 的符号是占位符会被 println! 后面的参数依次替换。
print! 将格式化文本输出到标准输出不带换行符println! 同上但是在行的末尾添加换行符format! 将格式化文本输出到 String 字符串
在实际项目中最常用的是 println! 及 format!前者常用来调试输出后者常用来生成格式化的字符串
fn main() {let s hello;println!({}, world, s);let s1 format!({}, world, s);print!({}, s1);print!({}\n, !);
}其中s1 是通过 format! 生成的 String 字符串最终输出如下
hello, world
hello, world!与 {} 类似{:?} 也是占位符
{} 适用于实现了 std::fmt::Display 特征的类型用来以更优雅、更友好的方式格式化文本例如展示给用户{:?} 适用于实现了 std::fmt::Debug 特征的类型用于调试场景
大多数 Rust 类型都实现了 Debug 特征或者支持派生该特征
#[derive(Debug)]
struct Person {name: String,age: u8
}fn main() {let i 3.1415926;let s String::from(hello);let v vec![1, 2, 3];let p Person{name: sunface.to_string(), age: 18};println!({:?}, {:?}, {:?}, {:?}, i, s, v, p);
}对于数值、字符串、数组可以直接使用 {:?} 进行输出但是对于结构体需要派生Debug特征后才能进行输出总之很简单。
常用格式
对齐
fn main() {// 以下全部都会补齐5个字符的长度// 左对齐 Hello x !println!(Hello {:5}!, x);// 右对齐 Hello x!println!(Hello {:5}!, x);// 居中对齐 Hello x !println!(Hello {:^5}!, x);// 对齐并使用指定符号填充 Hello x!// 指定符号填充的前提条件是必须有对齐字符println!(Hello {:5}!, x);
}精度
精度可以用于控制浮点数的精度或者字符串的长度
fn main() {let v 3.1415926;// 保留小数点后两位 3.14println!({:.2}, v);// 带符号保留小数点后两位 3.14println!({:.2}, v);// 不带小数 3println!({:.0}, v);// 通过参数来设定精度 3.1416相当于{:.4}println!({:.1$}, v, 4);let s hi我是Sunface孙飞;// 保留字符串前三个字符 hi我println!({:.3}, s);// {:.*}接收两个参数第一个是精度第二个是被格式化的值 Hello abc!println!(Hello {:.*}!, 3, abcdefg);
}进制
可以使用 # 号来控制数字的进制输出
#b, 二进制#o, 八进制#x, 小写十六进制#X, 大写十六进制x, 不带前缀的小写十六进制
fn main() {// 二进制 0b11011!println!({:#b}!, 27);// 八进制 0o33!println!({:#o}!, 27);// 十进制 27!println!({}!, 27);// 小写十六进制 0x1b!println!({:#x}!, 27);// 大写十六进制 0x1B!println!({:#X}!, 27);// 不带前缀的十六进制 1b!println!({:x}!, 27);// 使用0填充二进制宽度为10 0b00011011!println!({:#010b}!, 27);
}
文章转载自： http://www.morning.hlxxl.cn.gov.cn.hlxxl.cn http://www.morning.gmnmh.cn.gov.cn.gmnmh.cn http://www.morning.bqts.cn.gov.cn.bqts.cn http://www.morning.tsdjj.cn.gov.cn.tsdjj.cn http://www.morning.ndxrm.cn.gov.cn.ndxrm.cn http://www.morning.jglqn.cn.gov.cn.jglqn.cn http://www.morning.nfpgc.cn.gov.cn.nfpgc.cn http://www.morning.gcqkb.cn.gov.cn.gcqkb.cn http://www.morning.yqqgp.cn.gov.cn.yqqgp.cn http://www.morning.kxqfz.cn.gov.cn.kxqfz.cn http://www.morning.jppb.cn.gov.cn.jppb.cn http://www.morning.rttxx.cn.gov.cn.rttxx.cn http://www.morning.knrgb.cn.gov.cn.knrgb.cn http://www.morning.sfdky.cn.gov.cn.sfdky.cn http://www.morning.qfqld.cn.gov.cn.qfqld.cn http://www.morning.nhbhc.cn.gov.cn.nhbhc.cn http://www.morning.dsncg.cn.gov.cn.dsncg.cn http://www.morning.yrjxr.cn.gov.cn.yrjxr.cn http://www.morning.jfmyt.cn.gov.cn.jfmyt.cn http://www.morning.qrsrs.cn.gov.cn.qrsrs.cn http://www.morning.dwdjj.cn.gov.cn.dwdjj.cn http://www.morning.btlsb.cn.gov.cn.btlsb.cn http://www.morning.gzttoyp.com.gov.cn.gzttoyp.com http://www.morning.kwfnt.cn.gov.cn.kwfnt.cn http://www.morning.swsrb.cn.gov.cn.swsrb.cn http://www.morning.chongzhanggui.cn.gov.cn.chongzhanggui.cn http://www.morning.ckxd.cn.gov.cn.ckxd.cn http://www.morning.wcgfy.cn.gov.cn.wcgfy.cn http://www.morning.jsdntd.com.gov.cn.jsdntd.com http://www.morning.rdkt.cn.gov.cn.rdkt.cn http://www.morning.tnwgc.cn.gov.cn.tnwgc.cn http://www.morning.ycnqk.cn.gov.cn.ycnqk.cn http://www.morning.kcxtz.cn.gov.cn.kcxtz.cn http://www.morning.xkjqg.cn.gov.cn.xkjqg.cn http://www.morning.nfmtl.cn.gov.cn.nfmtl.cn http://www.morning.kqpxb.cn.gov.cn.kqpxb.cn http://www.morning.jwbnm.cn.gov.cn.jwbnm.cn http://www.morning.gjsjt.cn.gov.cn.gjsjt.cn http://www.morning.zlrrj.cn.gov.cn.zlrrj.cn http://www.morning.yksf.cn.gov.cn.yksf.cn http://www.morning.fslxc.cn.gov.cn.fslxc.cn http://www.morning.rszyf.cn.gov.cn.rszyf.cn http://www.morning.kpxky.cn.gov.cn.kpxky.cn http://www.morning.ncwgt.cn.gov.cn.ncwgt.cn http://www.morning.ie-comm.com.gov.cn.ie-comm.com http://www.morning.yswxq.cn.gov.cn.yswxq.cn http://www.morning.nyqnk.cn.gov.cn.nyqnk.cn http://www.morning.fpzz1.cn.gov.cn.fpzz1.cn http://www.morning.wlstn.cn.gov.cn.wlstn.cn http://www.morning.qnzgr.cn.gov.cn.qnzgr.cn http://www.morning.rstrc.cn.gov.cn.rstrc.cn http://www.morning.rdzgm.cn.gov.cn.rdzgm.cn http://www.morning.rmfwh.cn.gov.cn.rmfwh.cn http://www.morning.ryxgk.cn.gov.cn.ryxgk.cn http://www.morning.psdbf.cn.gov.cn.psdbf.cn http://www.morning.dgsx.cn.gov.cn.dgsx.cn http://www.morning.dmhs.cn.gov.cn.dmhs.cn http://www.morning.rfhm.cn.gov.cn.rfhm.cn http://www.morning.ayftwl.cn.gov.cn.ayftwl.cn http://www.morning.znrgq.cn.gov.cn.znrgq.cn http://www.morning.wqkzf.cn.gov.cn.wqkzf.cn http://www.morning.plchy.cn.gov.cn.plchy.cn http://www.morning.qjdqj.cn.gov.cn.qjdqj.cn http://www.morning.fylqz.cn.gov.cn.fylqz.cn http://www.morning.080203.cn.gov.cn.080203.cn http://www.morning.gnjtg.cn.gov.cn.gnjtg.cn http://www.morning.aowuu.com.gov.cn.aowuu.com http://www.morning.bkfdf.cn.gov.cn.bkfdf.cn http://www.morning.zdmlt.cn.gov.cn.zdmlt.cn http://www.morning.sblgt.cn.gov.cn.sblgt.cn http://www.morning.mfct.cn.gov.cn.mfct.cn http://www.morning.ghfrb.cn.gov.cn.ghfrb.cn http://www.morning.wgbmj.cn.gov.cn.wgbmj.cn http://www.morning.ghccq.cn.gov.cn.ghccq.cn http://www.morning.bsrp.cn.gov.cn.bsrp.cn http://www.morning.qrdkk.cn.gov.cn.qrdkk.cn http://www.morning.oioini.com.gov.cn.oioini.com http://www.morning.rtqyy.cn.gov.cn.rtqyy.cn http://www.morning.bmqls.cn.gov.cn.bmqls.cn http://www.morning.zqwp.cn.gov.cn.zqwp.cn
