title | tags | ||||
---|---|---|---|---|---|
19. 所有权-Move |
|
我最近在学cairo-lang
,巩固一下细节,也写一个WTF Cairo极简教程
,供小白们使用。教程基于cairo 2.2.0
版本。
WTF Academy 社群:Discord|微信群|官网 wtf.academy
所有代码和教程开源在 github: github.com/WTFAcademy/WTF-Cairo
在本章中,我们将探讨 Cairo 中的 Move
概念,即从一个变量向另一个变量转移所有权。
在我们继续之前,让我们简要回顾一下 Cairo 中的所有权规则:
- Cairo 中的每一个值都有一个 所有者(owner)。
- 值在任一时刻有且只有一个所有者。
- 当所有者(变量)离开作用域,这个值将被丢弃。
- 如果一个值的所有权没有被 转移(move),它不能离开作用域。
在上一章中,我们探讨了规则 #3。在这一章中,我们将专注于规则 #1 和 #2。
在 Cairo 中,Move
指的是一个变量向另一个变量转移所有权的过程。当数据从一个变量分配给另一个变量或作为函数参数传递时,该数据的所有权被移动到新变量。移动之后,原始变量将变得无效。
这是一个简单的例子:
let x = ArrayTrait::<felt252>::new(); // x 成为数据的所有者
let y = x; // 所有权从 x 移动到 y
let z = x; // 这将导致编译错误:error: Variable was previously moved
在上述代码中,x
最初拥有 array
。当我们将 x
分配给 y
时,array
的所有权从 x
移动到 y
。此次移动之后,x
不再有效,试图使用它(如 let z = x
)将导致编译错误。
以下是带有函数的另一个例子:
fn move_function(){
let x = ArrayTrait::<felt252>::new(); // x 进入作用域
takes_ownership(x); // x 的值移动到函数中
// ... 因此在这里不再有效
let y = x; // 这将导致编译错误,因为 x 不再有效
} // 这里,x 超出范围,但因为它的值被移动了,所以什么都没发生
在上述代码中,x
最初拥有 array
。当我们将 x
传递给 takes_ownership()
函数时,array
的所有权从 x
移动到 takes_ownership()
。此次移动后,x
不再有效,尝试使用它(如 let y = x
)将导致编译错误。
需要注意的是,结构体字段可以被单独move,即Move结构体中的一个字段的结构体,整个结构体不可以再被move,但依然可以访问结构体的其他成员。如果被move的字段重新赋值,结构体又可以继续被move。
#[derive(Drop)]
struct User {
name: felt252,
age: u8,
school: School
}
#[derive(Drop)]
struct School {
name: felt252
}
fn give_ownership(name: felt252, age: u8, school_name: felt252) -> User {
User { name: name, age: age, school: School { name: school_name } }
}
fn use_User(user: User) {}
fn school_name(school:School){}
#[external(v0)]
fn struct_move(self: @ContractState) -> u8{
let mut u = give_ownership('WTF', 3, 'WTF Academy');
//note: variable was previously used here:
school_name(u.school);
//error: Variable was previously moved.
//use_User(u);
let y = u.age;
y
}
#[external(v0)]
fn struct_move_second(self: @ContractState){
let mut u = give_ownership('WTF', 3, 'WTF Academy');
school_name(u.school);
u.school = School{
name:'new WTF'
};
use_User(u);
}
Cairo 中的 Copy
和 Drop
特性直接与 Move
语义相关。如果没有正确理解这些特性,你的程序可能会经常遇到 error: Variable not dropped.
和 error: Variable was previously moved.
这样的错误。
需要注意的是,如果一个结构体中的某个成员没有该特性,那么该结构体也不能拥有该特性,否则在编译时会报错。
error: Invalid copy trait implementation, Trait has no implementation in context: core::traits::Copy::<move_example::move_example::error_handling::Copy_example_2>.
#[derive(Copy,Drop)]
struct Copy_example_1 {
name: felt252,
test: Copy_example_2
}
#[derive(Drop)]
struct Copy_example_2 {
name: felt252
}
实现 Copy
特性的类型不被 Move
语义约束。当一个 Copy
类型的值被分配给一个新的变量或传递给一个函数时,会创建一份原始值的副本传递给它,而不会转移原始值的所有权。Cairo 中,整数和 felt252 类型默认实现了 Copy
特性,下面的程序可以正常运行。
// uint 和 felt 默认实现 Copy 特性
let x = 5; // x 成为值 5 的所有者
let y = x; // 生成了一份 x 的值的拷贝,并绑定到 y
let z = x; // 又生成了一份 x 的值的拷贝,并绑定到 z
此外,你可以通过在类型定义上添加 #[derive(Copy)]
注解来在自定义类型上实现 Copy 特性。注意 Arrays 和 Dictionaries 不能被复制。以下是一个带有实现了 Copy 特性的 struct 的例子:
#[derive(Copy, Drop)]
struct Point {
x: u128,
y: u128,
}
// copy 结构体示例,Point 在合约中手动实现了 Copy 特性
fn copy_struct(){
// Point 结构体实现了 Copy 特性
let p1 = Point { x: 5, y: 10 };
foo(p1); // p1 的所有权没有被移动,而是生成了一份拷贝传递给 foo()
foo(p1); // p1 可以被再次使用
}
fn foo(p: Point) {
// 对 p 做一些操作
}
Cairo 中有一个规则:一个值如果之前没被 Move
过,超出范围(Scope)的时候就会报错。实现 Drop
特性的类型被允许没被 Move
就超出范围。你可以通过向你的自定义类型添加 #[derive(Drop)]
属性来实现这一点。
#[derive(Drop)]
struct Point_Drop {
x: u128,
y: u128,
}
// drop 示例
fn drop_struct(){
let p1 = Point_Drop { x: 5, y: 10 };
}
默认情况下,整数和 felt252 实现了 Drop
特性。所有自定义类型都需要标注 Drop
,以便在它们超出范围时可以被正确地丢弃。
与Drop
类似,也用于清理占用的内存资源。当结构体内使用了字典(Dictionaries)时,由于字典不能使用Drop
特性,所有需要使用Destruct
特性来进行内存释放。
#[derive(Destruct)]
struct Dict_Drop {
mapping: Felt252Dict<felt252>
}
// destruct 示例
fn drop_struct(){
Dict_Drop { mapping: Default::default() };
}
在本节中,我们讨论了 Cairo 中的 Move 概念,包括 Copy
,Drop
和Destruct
特性。理解这些基本原理将使你能够在 Cairo 中编写更高效且无bug的代码。在我们进入更复杂的主题之前,请确保你掌握了这些概念。