路径

路径是由一个或多个路径段组成的序列,这些路径段由命名空间限定符 (::)逻辑上分隔。如果路径仅包含一个段,则它引用本地控制作用域中的项目变量。如果路径包含多个段,则它始终引用一个项目。

两个仅由标识符段组成的简单路径示例

x;
x::y::z;

路径类型

简单路径

语法

SimplePath :

   ::? SimplePathSegment (:: SimplePathSegment)*

SimplePathSegment :

   标识符 | super | self | crate | $crate

简单路径用于可见性标记、属性use项目。示例

#![allow(unused)]
fn main() {
use std::io::{self, Write};
mod m {
    #[clippy::cyclomatic_complexity = "0"]
    pub (in super) fn f1() {}
}
}

表达式中的路径

语法

PathInExpression :

   ::? PathExprSegment (:: PathExprSegment)*

PathExprSegment :

   PathIdentSegment (:: GenericArgs)?

PathIdentSegment :

   标识符 | super | self | Self | crate | $crate

GenericArgs :

      < >

   | < ( GenericArg , )* GenericArg ,? >

GenericArg :

   生命周期 | 类型 | GenericArgsConst | GenericArgsBinding | GenericArgsBounds

GenericArgsConst :

      BlockExpression

   | 字面量表达式

   | - 字面量表达式

   | SimplePathSegment

GenericArgsBinding :

   标识符 GenericArgs? = 类型

GenericArgsBounds :

   标识符 GenericArgs? : TypeParamBounds

表达式中的路径允许指定带有泛型参数的路径。它们用于表达式模式中的各个位置。

在泛型参数的开头 < 之前需要使用 :: 词法单元,以避免与小于运算符混淆。这通常被称为“涡轮鱼”语法。

#![allow(unused)]
fn main() {
(0..10).collect::<Vec<_>>();
Vec::<u8>::with_capacity(1024);
}

泛型参数的顺序限制为:生命周期参数、类型参数、常量参数,然后是相等约束。

常量参数必须用大括号括起来,除非它们是字面量或单段路径。

对应于 impl Trait 类型的合成类型参数是隐式的,这些参数不能显式指定。

限定路径

语法

表达式中的限定路径 :

   限定路径类型 (:: 路径表达式段)+

限定路径类型 :

   < 类型 (as 类型路径)? >

类型中的限定路径 :

   限定路径类型 (:: 类型路径段)+

完全限定路径允许消除 trait 实现 的路径歧义,并指定 规范路径。当在类型规范中使用时,它支持使用下面指定的类型语法。

#![allow(unused)]
fn main() {
struct S;
impl S {
    fn f() { println!("S"); }
}
trait T1 {
    fn f() { println!("T1 f"); }
}
impl T1 for S {}
trait T2 {
    fn f() { println!("T2 f"); }
}
impl T2 for S {}
S::f();  // Calls the inherent impl.
<S as T1>::f();  // Calls the T1 trait function.
<S as T2>::f();  // Calls the T2 trait function.
}

类型中的路径

语法

类型路径 :

   ::? 类型路径段 (:: 类型路径段)*

类型路径段 :

   路径标识符段 (::? (泛型参数 | 类型路径函数))?

类型路径函数 :

( 类型路径函数输入? ) (-> 无边界类型)?

类型路径函数输入 :

类型 (, 类型)* ,?

类型路径用于类型定义、trait 边界、类型参数边界和限定路径中。

虽然在泛型参数之前允许使用 :: 标记,但这不是必需的,因为不像在 表达式中的路径 中那样存在歧义。

#![allow(unused)]
fn main() {
mod ops {
    pub struct Range<T> {f1: T}
    pub trait Index<T> {}
    pub struct Example<'a> {f1: &'a i32}
}
struct S;
impl ops::Index<ops::Range<usize>> for S { /*...*/ }
fn i<'a>() -> impl Iterator<Item = ops::Example<'a>> {
    // ...
   const EXAMPLE: Vec<ops::Example<'static>> = Vec::new();
   EXAMPLE.into_iter()
}
type G = std::boxed::Box<dyn std::ops::FnOnce(isize) -> isize>;
}

路径限定符

路径可以用各种前导限定符来表示,以改变其解析方式的含义。

::

:: 开头的路径被认为是*全局路径*,其中路径的段从一个根据版本不同而不同的位置开始解析。路径中的每个标识符都必须解析为一个项。

**版本差异**:在 2015 版中,标识符从“crate 根”(2018 版中的 crate::)开始解析,其中包含各种不同的项,包括外部 crate、默认 crate(如 stdcore)以及 crate 顶层的项(包括 use 导入)。

从 2018 版开始,以 :: 开头的路径从 外部前奏 中的 crate 开始解析。也就是说,它们后面必须跟着 crate 的名称。

#![allow(unused)]
fn main() {
pub fn foo() {
    // In the 2018 edition, this accesses `std` via the extern prelude.
    // In the 2015 edition, this accesses `std` via the crate root.
    let now = ::std::time::Instant::now();
    println!("{:?}", now);
}
}
// 2015 Edition
mod a {
    pub fn foo() {}
}
mod b {
    pub fn foo() {
        ::a::foo(); // call `a`'s foo function
        // In Rust 2018, `::a` would be interpreted as the crate `a`.
    }
}
fn main() {}

self

self 解析相对于当前模块的路径。self 只能用作第一个段,前面不能有 ::

在方法体中,由单个 self 段组成的路径解析为方法的 self 参数。

fn foo() {}
fn bar() {
    self::foo();
}
struct S(bool);
impl S {
  fn baz(self) {
        self.0;
    }
}
fn main() {}

Self

Self,首字母大写“S”,用于在 trait实现 中引用实现类型。

Self 只能用作第一个段,前面不能有 ::

#![allow(unused)]
fn main() {
trait T {
    type Item;
    const C: i32;
    // `Self` will be whatever type that implements `T`.
    fn new() -> Self;
    // `Self::Item` will be the type alias in the implementation.
    fn f(&self) -> Self::Item;
}
struct S;
impl T for S {
    type Item = i32;
    const C: i32 = 9;
    fn new() -> Self {           // `Self` is the type `S`.
        S
    }
    fn f(&self) -> Self::Item {  // `Self::Item` is the type `i32`.
        Self::C                  // `Self::C` is the constant value `9`.
    }
}
}

super

路径中的 super 解析为父模块。它只能在路径的前导段中使用,可能在初始 self 段之后。

mod a {
    pub fn foo() {}
}
mod b {
    pub fn foo() {
        super::a::foo(); // call a's foo function
    }
}
fn main() {}

在第一个 superself 之后,super 可以重复多次,以引用祖先模块。

mod a {
    fn foo() {}

    mod b {
        mod c {
            fn foo() {
                super::super::foo(); // call a's foo function
                self::super::super::foo(); // call a's foo function
            }
        }
    }
}
fn main() {}

crate

crate 解析相对于当前 crate 的路径。crate 只能用作第一个段,前面不能有 ::

fn foo() {}
mod a {
    fn bar() {
        crate::foo();
    }
}
fn main() {}

$crate

$crate 仅在 宏转写器 中使用,并且只能用作第一个段,前面不能有 ::$crate 将扩展为一个路径,用于从定义宏的 crate 的顶层访问项,而不管宏是在哪个 crate 中调用的。

pub fn increment(x: u32) -> u32 {
    x + 1
}

#[macro_export]
macro_rules! inc {
    ($x:expr) => ( $crate::increment($x) )
}
fn main() { }

规范路径

在模块或实现中定义的项具有一个*规范路径*,该路径对应于它在其 crate 中的定义位置。所有其他指向这些项的路径都是别名。规范路径定义为*路径前缀*,后跟项本身定义的路径段。

实现use 声明 没有规范路径,尽管实现定义的项确实有规范路径。在块表达式中定义的项没有规范路径。在没有规范路径的模块中定义的项没有规范路径。在引用没有规范路径的项的实现中定义的关联项(例如,作为实现类型、正在实现的 trait、类型参数或类型参数上的边界)没有规范路径。

模块的路径前缀是该模块的规范路径。对于裸实现,它是被 尖括号 (<>) 包围的正在实现的项的规范路径。对于 trait 实现,它是正在实现的项的规范路径,后跟 as,再后跟 trait 的规范路径,所有这些都包含在 尖括号 (<>) 中。

规范路径仅在给定的 crate 中有意义。crate 之间没有全局命名空间;项的规范路径只是在 crate 中标识它。

// Comments show the canonical path of the item.

mod a { // crate::a
    pub struct Struct; // crate::a::Struct

    pub trait Trait { // crate::a::Trait
        fn f(&self); // crate::a::Trait::f
    }

    impl Trait for Struct {
        fn f(&self) {} // <crate::a::Struct as crate::a::Trait>::f
    }

    impl Struct {
        fn g(&self) {} // <crate::a::Struct>::g
    }
}

mod without { // crate::without
    fn canonicals() { // crate::without::canonicals
        struct OtherStruct; // None

        trait OtherTrait { // None
            fn g(&self); // None
        }

        impl OtherTrait for OtherStruct {
            fn g(&self) {} // None
        }

        impl OtherTrait for crate::a::Struct {
            fn g(&self) {} // None
        }

        impl crate::a::Trait for OtherStruct {
            fn f(&self) {} // None
        }
    }
}

fn main() {}