定义和实例化结构体

结构体类似于“元组类型”章节中讨论的元组,两者都持有多个相关的值。与元组一样,结构体的各个部分可以是不同的类型。与元组不同的是,在结构体中,你会为每块数据命名,这样就可以清楚地知道这些值的含义。添加这些名称意味着结构体比元组更灵活:你不必依赖数据的顺序来指定或访问实例的值。

要定义一个结构体,我们输入关键字 struct 并命名整个结构体。结构体的名称应该描述被分组在一起的数据片段的意义。然后,在花括号内,我们定义数据片段的名称和类型,我们称之为字段。例如,清单 5-1 展示了一个存储用户帐户信息的结构体。

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn main() {}
清单 5-1: User 结构体定义

要在定义结构体后使用它,我们需要通过为每个字段指定具体值来创建该结构体的实例。我们通过声明结构体的名称,然后添加包含键: 值对的花括号来创建一个实例,其中键是字段的名称,值是我们要存储在这些字段中的数据。我们不必按照在结构体中声明它们的顺序来指定字段。换句话说,结构体定义就像类型的通用模板,实例使用特定的数据填充该模板以创建该类型的值。例如,我们可以声明一个特定的用户,如清单 5-2 所示。

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn main() {
    let user1 = User {
        active: true,
        username: String::from("someusername123"),
        email: String::from("[email protected]"),
        sign_in_count: 1,
    };
}
清单 5-2: 创建 User 结构体的实例

要从结构体中获取特定值,我们使用点号表示法。例如,要访问此用户的电子邮件地址,我们使用 user1.email。如果实例是可变的,我们可以通过使用点号表示法并赋值给特定字段来更改值。清单 5-3 展示了如何更改可变 User 实例的 email 字段中的值。

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn main() {
    let mut user1 = User {
        active: true,
        username: String::from("someusername123"),
        email: String::from("[email protected]"),
        sign_in_count: 1,
    };

    user1.email = String::from("[email protected]");
}
清单 5-3: 更改 User 实例的 email 字段中的值

请注意,整个实例必须是可变的;Rust 不允许我们只将某些字段标记为可变的。与任何表达式一样,我们可以在函数体中构造一个新的结构体实例作为最后一个表达式,以隐式返回该新实例。

清单 5-4 展示了一个 build_user 函数,该函数返回一个具有给定电子邮件和用户名的 User 实例。active 字段获取值 true,而 sign_in_count 获取值 1

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn build_user(email: String, username: String) -> User {
    User {
        active: true,
        username: username,
        email: email,
        sign_in_count: 1,
    }
}

fn main() {
    let user1 = build_user(
        String::from("[email protected]"),
        String::from("someusername123"),
    );
}
清单 5-4: 一个 build_user 函数,它接受电子邮件和用户名并返回一个 User 实例

用与结构体字段相同的名称来命名函数参数是有意义的,但是必须重复 emailusername 字段名称和变量有点乏味。如果结构体有更多字段,重复每个名称会更加烦人。幸运的是,这里有一个方便的简写方式!

使用字段初始化简写

由于清单 5-4 中的参数名称和结构体字段名称完全相同,我们可以使用字段初始化简写语法来重写 build_user,使其行为完全相同,但不会重复 usernameemail,如清单 5-5 所示。

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn build_user(email: String, username: String) -> User {
    User {
        active: true,
        username,
        email,
        sign_in_count: 1,
    }
}

fn main() {
    let user1 = build_user(
        String::from("[email protected]"),
        String::from("someusername123"),
    );
}
清单 5-5: 一个 build_user 函数,它使用字段初始化简写,因为 usernameemail 参数与结构体字段具有相同的名称

在这里,我们正在创建一个新的 User 结构体的实例,它有一个名为 email 的字段。我们想将 email 字段的值设置为 build_user 函数的 email 参数中的值。因为 email 字段和 email 参数具有相同的名称,我们只需要写入 email 而不是 email: email

使用结构体更新语法从其他实例创建实例

创建一个新结构体实例通常很有用,该实例包含来自另一个实例的大部分值,但更改了一些值。你可以使用结构体更新语法来做到这一点。

首先,在清单 5-6 中,我们展示了如何使用常规方式在 user2 中创建一个新的 User 实例,而无需使用更新语法。我们为 email 设置了一个新值,但其他值使用我们在清单 5-2 中创建的 user1 中的相同值。

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn main() {
    // --snip--

    let user1 = User {
        email: String::from("[email protected]"),
        username: String::from("someusername123"),
        active: true,
        sign_in_count: 1,
    };

    let user2 = User {
        active: user1.active,
        username: user1.username,
        email: String::from("[email protected]"),
        sign_in_count: user1.sign_in_count,
    };
}
清单 5-6: 创建一个新的 User 实例,使用 user1 中除一个值之外的所有值

使用结构体更新语法,我们可以使用更少的代码实现相同的效果,如清单 5-7 所示。语法 .. 指定未显式设置的其余字段应具有与给定实例中的字段相同的值。

文件名:src/main.rs
struct User {
    active: bool,
    username: String,
    email: String,
    sign_in_count: u64,
}

fn main() {
    // --snip--

    let user1 = User {
        email: String::from("[email protected]"),
        username: String::from("someusername123"),
        active: true,
        sign_in_count: 1,
    };

    let user2 = User {
        email: String::from("[email protected]"),
        ..user1
    };
}
清单 5-7: 使用结构体更新语法为 User 实例设置新的 email 值,但使用 user1 中的其余值

清单 5-7 中的代码还在 user2 中创建了一个实例,该实例的 email 值不同,但 usernameactivesign_in_count 字段的值与 user1 中的值相同。..user1 必须放在最后,以指定任何剩余字段都应从 user1 中的相应字段获取值,但是我们可以选择以任何顺序为任意多个字段指定值,而不管结构体定义中字段的顺序如何。

请注意,结构体更新语法使用 = 就像赋值一样;这是因为它移动了数据,正如我们在“变量和数据与移动交互”章节中所见。在这个例子中,在创建 user2 后,我们不能再将 user1 作为一个整体使用,因为 user1username 字段中的 String 被移动到了 user2 中。如果我们给 user2emailusername 都赋予了新的 String 值,因此只使用了 user1 中的 activesign_in_count 值,那么 user1 在创建 user2 后仍然有效。activesign_in_count 都是实现 Copy trait 的类型,因此我们在“仅栈数据:复制”章节中讨论的行为将适用。我们仍然可以在此示例中使用 user1.email,因为它的值没有被移动出去。

使用没有命名字段的元组结构体创建不同的类型

Rust 还支持看起来类似于元组的结构体,称为元组结构体。元组结构体增加了结构体名称提供的含义,但其字段没有名称;相反,它们只有字段的类型。当你想给整个元组命名并使该元组与其他元组不同类型时,以及当像在常规结构体中那样命名每个字段会很冗长或多余时,元组结构体非常有用。

要定义元组结构体,请从 struct 关键字和结构体名称开始,后跟元组中的类型。例如,这里我们定义并使用了两个名为 ColorPoint 的元组结构体

文件名:src/main.rs
struct Color(i32, i32, i32);
struct Point(i32, i32, i32);

fn main() {
    let black = Color(0, 0, 0);
    let origin = Point(0, 0, 0);
}

请注意,blackorigin 值是不同的类型,因为它们是不同元组结构体的实例。你定义的每个结构体都是其自己的类型,即使结构体内的字段可能具有相同的类型。例如,一个采用 Color 类型参数的函数不能将 Point 作为参数,即使这两种类型都由三个 i32 值组成。否则,元组结构体实例类似于元组,你可以将它们解构为其单独的部分,并且可以使用 . 后跟索引来访问单个值。

没有任何字段的类单元结构体

你还可以定义没有任何字段的结构体!这些被称为类单元结构体,因为它们的行为类似于“元组类型”章节中提到的单元类型 ()。当你需要在某种类型上实现一个 trait 但又不想在该类型本身中存储任何数据时,类单元结构体可能很有用。我们将在第 10 章中讨论 trait。这里有一个声明和实例化一个名为 AlwaysEqual 的单元结构体的示例

文件名:src/main.rs
struct AlwaysEqual;

fn main() {
    let subject = AlwaysEqual;
}

要定义 AlwaysEqual,我们使用 struct 关键字,我们想要的名称,然后是一个分号。不需要花括号或圆括号!然后,我们可以通过类似的方式在 subject 变量中获取 AlwaysEqual 的实例:使用我们定义的名称,而无需任何花括号或圆括号。想象一下,稍后我们将为此类型实现行为,以便 AlwaysEqual 的每个实例始终等于任何其他类型的每个实例,也许是为了获得测试目的的已知结果。我们不需要任何数据来实现该行为!你将在第 10 章中看到如何定义 trait 并将其实现到任何类型上,包括类单元结构体。

结构体数据的所有权

在清单 5-1 中的 User 结构体定义中,我们使用了拥有的 String 类型,而不是 &str 字符串切片类型。这是一个有意的选择,因为我们希望此结构体的每个实例都拥有其所有数据,并且该数据在整个结构体有效的时间内都有效。

结构体也可以存储对其他对象拥有的数据的引用,但是这样做需要使用生命周期,这是 Rust 的一项功能,我们将在第 10 章中讨论。生命周期确保结构体引用的数据在结构体存在期间有效。假设你尝试在结构体中存储引用而不指定生命周期,就像下面这样;这行不通

文件名:src/main.rs
struct User {
    active: bool,
    username: &str,
    email: &str,
    sign_in_count: u64,
}

fn main() {
    let user1 = User {
        active: true,
        username: "someusername123",
        email: "[email protected]",
        sign_in_count: 1,
    };
}

编译器会抱怨它需要生命周期说明符

$ cargo run
   Compiling structs v0.1.0 (file:///projects/structs)
error[E0106]: missing lifetime specifier
 --> src/main.rs:3:15
  |
3 |     username: &str,
  |               ^ expected named lifetime parameter
  |
help: consider introducing a named lifetime parameter
  |
1 ~ struct User<'a> {
2 |     active: bool,
3 ~     username: &'a str,
  |

error[E0106]: missing lifetime specifier
 --> src/main.rs:4:12
  |
4 |     email: &str,
  |            ^ expected named lifetime parameter
  |
help: consider introducing a named lifetime parameter
  |
1 ~ struct User<'a> {
2 |     active: bool,
3 |     username: &str,
4 ~     email: &'a str,
  |

For more information about this error, try `rustc --explain E0106`.
error: could not compile `structs` (bin "structs") due to 2 previous errors

在第 10 章中,我们将讨论如何修复这些错误,以便你可以将引用存储在结构体中,但是现在,我们将使用拥有的类型(如 String)而不是引用(如 &str)来修复此类错误。