By 任怀林

今天在看Sea ORM的例子时，看到一段代码：

use sea_orm::*;

 const DATABASE_URL: &str = "mysql://root:root@localhost:3306";
 const DB_NAME: &str = "bakeries_db";

 pub(super) async fn set_up_db() -> Result<DatabaseConnection, DbErr> {
     let db = Database::connect(DATABASE_URL).await?;

     let db = match db.get_database_backend() {
         DbBackend::MySql => {
             db.execute(Statement::from_string(
                 db.get_database_backend(),
                 format!("CREATE DATABASE IF NOT EXISTS `{}`;", DB_NAME),
             ))
             .await?;

             let url = format!("{}/{}", DATABASE_URL, DB_NAME);
             Database::connect(&url).await?
         }
         DbBackend::Postgres => {
             db.execute(Statement::from_string(
                 db.get_database_backend(),
                 format!("DROP DATABASE IF EXISTS \"{}\";", DB_NAME),
             ))
             .await?;
             db.execute(Statement::from_string(
                 db.get_database_backend(),
                 format!("CREATE DATABASE \"{}\";", DB_NAME),
             ))
             .await?;

             let url = format!("{}/{}", DATABASE_URL, DB_NAME);
             Database::connect(&url).await?
         }
         DbBackend::Sqlite => db,
     };

     Ok(db)
 }

我对函数前面的pub(super)有点不明白，猜想可能跟java的public差不多，于是去查Rust Book，结果里面没有讲。

在Rust语言圣经里找到了相关的章节说明，受限可见性

限制可见性语法

pub(crate) 或 pub(in crate::a) 就是限制可见性语法，前者是限制在整个包内可见，后者是通过绝对路径，限制在包内的某个模块内可见，总结一下：

  • pub 意味着可见性无任何限制
  • pub(crate) 表示在当前包可见
  • pub(self) 在当前模块可见
  • pub(super) 在父模块可见
  • pub(in <path>) 表示在某个路径代表的模块中可见，其中 path 必须是父模块或者祖先模块

为了理解pub(super),我写了下面的测试代码。

mod parent_module {
        use self::child_module::say_hi;

        // 这是子模块
        pub mod child_module {
            // 这是在子模块中的函数
            pub(super) fn say_hi() {
                println!("Hello world!")
            }

            #[test]
            fn test3() {
                say_hi();
            }
        }

        mod child2_module {
            use super::child_module::say_hi;

            #[test]
            fn test2() {
                say_hi();
            }
        }

        #[test]
        fn test1() {
            say_hi();
        }
    }

mod uncle_module {
    // 下面的代码会编译出错
	use super::parent_module::child_module::say_hi;
	 #[test]
	 fn test1() {
		 say_hi();
	 }
}

我在child_module里定义了一个函数say_hi，并限定为pub(super),下面是测试结论。

  1. 在child2_module，也就是child_module同级（兄弟）模块里，可以调用say_hi。
  2. 在parent_module，也就是child_module父模块里，可以调用say_hi。
  3. 在uncle_module，也就是child_module叔叔模块里，不可以调用say_hi。

可以pub(super)修饰的函数，在当前模块的父模块范围内都可以引用并调用，超出范围就不可见了。