Skip to main content

Class: BoolSetting

A typed view of a 0x2::config::Setting<bool> held in a dynamic field of a [Config] object — the shape used by the deny list for its per-address and global-pause entries.

A setting carries the value for the epoch it was last written in plus the value that preceded it, so a reader can tell which one applies to the epoch it cares about.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "BoolSetting" = "BoolSetting";

Methods​

newerValue()​

newerValue(): boolean | undefined;

The value written in newer_value_epoch.

Returns​

boolean | undefined

Implementation of​

BoolSettingLike.newerValue

newerValueEpoch()​

newerValueEpoch(): bigint | undefined;

The epoch newer_value was written in, if the setting holds data.

Returns​

bigint | undefined

Implementation of​

BoolSettingLike.newerValueEpoch

olderValue()​

olderValue(): boolean | undefined;

The value that applied before newer_value_epoch.

Returns​

boolean | undefined

Implementation of​

BoolSettingLike.olderValue

toDebugString()​

toDebugString(): string;

Returns​

string

toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string

uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

instanceOf()​

static instanceOf(obj_): obj_ is BoolSetting;

Parameters​

obj_​

any

Returns​

obj_ is BoolSetting

tryFromBcs()​

static tryFromBcs(bytes): BoolSettingLike;

Decode a Setting<bool> from raw BCS bytes.

There is no object-based constructor: a setting is stored as a dynamic field of the config, not as a top-level object with its own type tag.

Parameters​

bytes​

ArrayBuffer

Returns​

BoolSettingLike