定义和实例化结构体

结构体类似于元组,在 “元组类型”部分中讨论过,它们都包含多个相关的值。与元组一样,结构体的各个部分可以是不同的类型。与元组不同,在结构体中,您将为每个数据部分命名,以便清楚地了解这些值的含义。添加这些名称意味着结构体比元组更灵活:您不必依赖数据的顺序来指定或访问实例的值。

要定义结构体,我们输入关键字 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 字段的值为 truesign_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:使用除一个值之外的所有来自 user1 的值创建新的 User 实例

使用结构体更新语法,我们可以用更少的代码实现相同的效果,如清单 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 值,那么在创建 user2 后,user1 仍然有效。activesign_in_count 都是实现了 Copy 特征的类型,因此我们在 “仅堆栈数据:复制”部分中讨论的行为将适用。

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

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 值组成。否则,元组结构体实例类似于元组,您可以将它们分解成各个部分,并且可以使用 . 后跟索引来访问单个值。

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

您还可以定义没有任何字段的结构体!这些被称为单元结构体,因为它们的行为类似于 (),即我们在 “元组类型”部分中提到的单元类型。当您需要在某些类型上实现特征,但没有要存储在类型本身中的任何数据时,单元结构体很有用。我们将在第 10 章中讨论特征。以下是如何声明和实例化名为 AlwaysEqual 的单元结构体的示例

文件名:src/main.rs

struct AlwaysEqual;

fn main() {
    let subject = AlwaysEqual;
}

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

结构体数据的拥有权

在清单 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 这样的引用。