rust入坑之旅-模块

Rust的包结构，根据代码层次来划分逻辑模块，Rust的模块如同其他语言的package，不同点在于模块可以包含以下项:函数，Struct， trait impl块, 或者包含其他的模块。

模块可见性

默认情况下，模块中的项拥有私有的可见性（私有的），不过可以加上 pub修饰语来重载这一行为。模块中只有公有的项可以从模块外的作用域访问.

在模块中的组成项默认是本模块私有可见
在模块中的组成项被pub来修饰之后可以被模块外的作用域访问
在同一模块中，每个组成项可以互相访问。

mod my_mod {
    // 模块中的项默认具有私有的可见性
    fn private_function() {
        println!("called `my_mod::private_function()`");
    }

    // 使用 `pub` 修饰语来改变默认可见性。
    pub fn function() {
        println!("called `my_mod::function()`");
    }

    // 在同一模块中，项可以访问其它项，即使它是私有的。
    pub fn indirect_access() {
        print!("called `my_mod::indirect_access()`, that\n> ");

    }
}
fn main() {
    my_mod::function();
}

在模块中含有嵌套模块的组成项默认是本嵌套模块私有可见，模块的私有项不能直接访问，即便它是嵌套在公有模块内部的
在模块中含有嵌套模块的组成项被pub来修饰之后可以被模块外的作用域访问
在模块中含有嵌套模块的组成项被使用 pub(in path) 语法定义的函数只在给定的路径中可见，path 必须是父模块（parent module）或祖先模块（ancestor module）
在模块中含有嵌套模块的组成项被使用 pub(self) 语法定义的函数则只在当前模块中可见。
在模块中含有嵌套模块的组成项被使用 pub(super) 语法定义的函数只在父模块中可见。

mod my_mod {
   // 模块也可以嵌套
    pub mod nested {
        pub fn function() {
            println!("called `my_mod::nested::function()`");
        }

        #[allow(dead_code)]
        fn private_function() {
            println!("called `my_mod::nested::private_function()`");
        }

        // 使用 `pub(in path)` 语法定义的函数只在给定的路径中可见。
        // `path` 必须是父模块（parent module）或祖先模块（ancestor module）
        pub(in crate::my_mod) fn public_function_in_my_mod() {
            print!("called `my_mod::nested::public_function_in_my_mod()`, that\n > ");
            public_function_in_nested()
        }

        // 使用 `pub(self)` 语法定义的函数则只在当前嵌套模块中可见。
        pub(self) fn public_function_in_nested() {
            println!("called `my_mod::nested::public_function_in_nested");
        }

        // 使用 `pub(super)` 语法定义的函数只在父模块中可见。
        pub(super) fn public_function_in_super_mod() {
            println!("called my_mod::nested::public_function_in_super_mod");
        }
    }

    pub fn call_public_function_in_my_mod() {
        print!("called `my_mod::call_public_funcion_in_my_mod()`, that\n> ");
        nested::public_function_in_my_mod();
        print!("> ");
        nested::public_function_in_super_mod();
    }

    // `pub(crate)` 使得函数只在当前 crate 中可见
    pub(crate) fn public_function_in_crate() {
        println!("called `my_mod::public_function_in_crate()");
    }
}
// link的错误示范
mod closure{
pub(crate) fn public_function_in_crate() {
    println!("called `closure::public_function_in_crate()");
    crate::my_mod::nested::public_function_in_my_mod()
}
}
fn main() {
    // 公有项，包括嵌套模块内的，都可以在父模块外部访问。
    my_mod::indirect_access();
    my_mod::nested::function();
    my_mod::call_public_function_in_my_mod();
    // closure::public_function_in_crate(); 这样会提示error[E0742]: visibilities can only be restricted to ancestor modules 
    // pub(crate) 项可以在同一个 crate 中的任何地方访问
    my_mod::public_function_in_crate();
}

结构体可见性

结构体的字段也是一个可见性的层次。字段默认拥有私有的可见性，也可以加上 pub 修饰语可以被变量访问，不过带有私有字段的结构体可以使用公有的构造器来创建。

mod struct_mod {
    // 一个公有的结构体，带有一个公有的字段（类型为泛型 `T`）
    pub struct OpenBox<T> {
        pub contents: T,
    }

    // 一个公有的结构体，带有一个私有的字段（类型为泛型 `T`）    
    #[allow(dead_code)]
    pub struct ClosedBox<T> {
        contents: T,
    }

    impl<T> ClosedBox<T> {
        // 一个公有的构造器方法
        pub fn new(contents: T) -> ClosedBox<T> {
            ClosedBox {
                contents: contents,
            }
        }
    }
}
fn main() {
    // 带有公有字段的公有结构体，可以像平常一样构造
    let open_box = struct_mod::OpenBox { contents: "public information" };

    // 并且它们的字段可以正常访问到。
    println!("The open box contains: {}", open_box.contents);

    // 带有私有字段的公有结构体不能使用字段名来构造。
    // 报错！`ClosedBox` 含有私有字段。
    //let closed_box = struct_mod::ClosedBox { contents: "classified information" };
    // 试一试 ^ 取消此行注释


    // 不过带有私有字段的结构体可以使用公有的构造器来创建。
    let _closed_box = struct_mod::ClosedBox::new("classified information");

    // 并且一个结构体中的私有字段不能访问到。
    // 报错！`content` 字段是私有的。
    //println!("The closed box contains: {}", _closed_box.contents);
    // 试一试 ^ 取消此行注释    

}

use 声明

use 声明可以将一个完整的路径绑定到一个新的名字，从而更容易访问。别名处理，use 绑定拥有局部作用域。

mod deeply {
    pub mod nested {
        pub fn function() {
            println!("called `deeply::nested::function()`")
        }
    }
}

fn function() {
    println!("called `my_mod::function()`");
}

fn main() {
    // 直接使用use别名访问函数 `deeply::nested::funcion`
    other_function();

    println!("Entering block");
    {
        // 这和 `use deeply::nested::function as function` 等价。
        // 此 `function()` 将遮蔽外部的同名函数。
        use deeply::nested::function;
        function();

        // `use` 绑定拥有局部作用域。在这个例子中，`function()`
        // 的遮蔽只存在在这个代码块中。
        println!("Leaving block");
    }
    //没有局部 use 访问的是本mod的function
    function();
}

super 和 self

在路径中使用 super （父级）和 self（自身）关键字，从而在访问项时消除歧义，以及防止不必要的路径硬编码。如：当前mod中可以用self来代替mod名称，super指定本mod外的的mod

fn function() {
    println!("called `function()`");
}

mod cool {
    pub fn function() {
        println!("called `cool::function()`");
    }
}

mod my {
    fn function() {
        println!("called `my::function()`");
    }
    
    mod cool {
        pub fn function() {
            println!("called `my::cool::function()`");
        }
    }
    
    pub fn indirect_call() {
        // 让我们从这个作用域中访问所有名为 `function` 的函数！
        print!("called `my::indirect_call()`, that\n> ");
        
        // `self` 关键字表示当前的模块作用域——在这个例子是 `my`。
        // 调用 `self::function()` 和直接调用 `function()` 都得到相同的结果，
        // 因为他们表示相同的函数。
        self::function();
        function();
        
        // 我们也可以使用 `self` 来访问 `my` 内部的另一个模块：
        self::cool::function();
        
        // `super` 关键字表示父作用域（在 `my` 模块外面）。
        super::function();
        
        // 这将在 *crate* 作用域内绑定 `cool::function` 。
        // 在这个例子中，crate 作用域是最外面的作用域。
        {
            use crate::cool::function as root_function;
            root_function();
        }
    }
}

mod文件可以分布在不用文件，即Rust项目的目录结构，在main中引用即可