G.NAM.02 类型转换函数命名宜遵循所有权语义

【级别】 建议

【描述】

Rust 语言依赖所有权来管理内存，所以在命名上遵循所有权语义，可以提升代码可读性和透明性，以便从代码命名中发现内存使用的代价。

【说明】

进行特定类型转换的方法名应该包含以下前缀：

名称前缀	内存代价	所有权	方法中`self`的类型
`as_`	无代价	borrowed -> borrowed	`&self` 或 `&mut self`
`to_`	代价昂贵	borrowed ->borrowed borrowed -> owned (非 Copy 类型) owned -> owned (Copy 类型)	&mut self &self (非 Copy 类型) self (Copy 类型)
`into_`	看情况	owned -> owned (非 Copy 类型)	`self`

以 as_ 和 into_ 作为前缀的类型转换通常是降低抽象层次，要么是查看背后的数据 (as)，要么是解构 (deconstruct) 背后的数据 ( into ) 。

相对来说，以 to_ 作为前缀的类型转换处于同一个抽象层次，但是底层会做更多工作，比如多了内存拷贝等操作。

当一个类型用更高级别的语义 (higher-level semantics) 封装 (wraps) 一个内部类型时，应该使用 into_inner() 方法名来取出被封装类型的值。

【反例】

Rust

fn main() {
  struct X();
  static S: &str = "str";

  impl X {
    // 不符合：as_ 命名的方法不应获取 self 的所有权
    fn as_str(self) -> &'static str {
      S
    }
    // 不符合：当返回值不是借用，to_ 命名的方法不应使用 &mut self 作为参数
    fn to_my_string(&mut self) -> String { S.to_string()
      }
    // 不符合：into_ 通常需要获取 self 的所有权
    fn into_my_string(&self) -> String { 
      S.to_string()
    }
  }
}

【正例】

Rust

fn main() {
  struct X();
  static S: &str = "str";

  impl X {
    // 符合：as_ 命名的方法只借用 self
    fn as_str(&self) -> &'static str {
    S
    }
    // 符合：返回值不是借用，且 self 对应的类型不支持 Copy 时，to_ 命名的方法则使用 &self 作为参数
    fn to_my_string(&self) -> String { S.to_string()
    }
    // 符合：into_ 命名的方法获取了 self 的所有权
    fn into_my_string(self) -> String { S.to_string()
    }
  }
}