Constants

常量是在模块内为共享的、静态的值命名的一种方式。

常量的值必须在编译时就能确定。常量的值会存储在编译后的模块中。每次使用常量时,都会创建该值的一个新副本。

声明

常量声明以const关键字开始,后面跟着名称、类型和值。

const <名称>: <类型> = <表达式>;

例如:

module a::example {
    const MY_ADDRESS: address = @a;

    public fun permissioned(addr: address) {
        assert!(addr == MY_ADDRESS, 0);
    }
}

命名规则

常量必须以大写字母A到Z开头。首字母之后,常量名可以包含下划线_、小写字母a到z、大写字母A到Z或数字0到9。

const FLAG: bool = false;
const EMyErrorCode: u64 = 0;
const ADDRESS_42: address = @0x42;

尽管你可以在常量中使用小写字母a到z,但通用样式指南建议只使用大写字母A到Z,并在每个单词之间使用下划线_。对于错误代码,我们使用E作为前缀,然后对其余部分使用大驼峰命名法(也称为帕斯卡命名法),如EMyErrorCode所示。

当前要求以A到Z开头的命名限制是为了给未来的语言特性留出空间。

可见性

目前不支持public或public(package)常量。const值只能在声明它的模块中使用。不过,为了方便起见,它们可以在单元测试属性中跨模块使用。

有效表达式

目前,常量限于原始类型bool、u8、u16、u32、u64、u128、u256、address和vector<T>,其中T是常量的有效类型。

值

通常,const被赋予一个简单的值或其类型的字面量。例如:

const MY_BOOL: bool = false;
const MY_ADDRESS: address = @0x70DD;
const BYTES: vector<u8> = b"hello world";
const HEX_BYTES: vector<u8> = x"DEADBEEF";

复杂表达式

除了字面量,常量还可以包含更复杂的表达式,只要编译器能够在编译时将表达式简化为一个值即可。

目前,可以使用相等操作、所有布尔操作、所有位操作和所有算术操作。

const RULE: bool = true && false;
const CAP: u64 = 10 * 100 + 1;
const SHIFTY: u8 = {
    (1 << 1) * (1 << 2) * (1 << 3) * (1 << 4)
};
const HALF_MAX: u128 = 340282366920938463463374607431768211455 / 2;
const REM: u256 =
    57896044618658097711785492504343953926634992332820282019728792003956564819968 % 654321;
const EQUAL: bool = 1 == 1;

如果操作会导致运行时异常,编译器会给出无法生成常量值的错误:

const DIV_BY_ZERO: u64 = 1 / 0; // 错误!
const SHIFT_BY_A_LOT: u64 = 1 << 100; // 错误!
const NEGATIVE_U64: u64 = 0 - 1; // 错误!

此外,常量可以引用同一模块内的其他常量:

const BASE: u8 = 4;
const SQUARE: u8 = BASE * BASE;

但请注意,常量定义中的任何循环引用都会导致错误:

const A: u16 = B + 1;
const B: u16 = A + 1; // 错误!