Enum TVMFFIFieldFlagBitMask

• Defined in File c_api.h

Enum Documentation

enum TVMFFIFieldFlagBitMask

bitmask of the field.

Values:

enumerator kTVMFFIFieldFlagBitMaskWritable

The field is writable.

enumerator kTVMFFIFieldFlagBitMaskHasDefault

The field has default value.

enumerator kTVMFFIFieldFlagBitMaskIsStaticMethod

The field is a static method.

enumerator kTVMFFIFieldFlagBitMaskSEqHashIgnore

The field should be ignored when performing structural eq/hash.

This is an optional meta-data for structural eq/hash.

enumerator kTVMFFIFieldFlagBitMaskSEqHashDef

The field enters a def region where var can be defined/matched.

This is an optional meta-data for structural eq/hash.

enumerator kTVMFFIFieldFlagBitMaskDefaultFromFactory

The default_value_or_factory is a callable factory function () -> Any.

When this flag is set along with kTVMFFIFieldFlagBitMaskHasDefault, the default_value_or_factory field contains a Function that should be called with no arguments to produce the default value, rather than being used directly as the default value.

enumerator kTVMFFIFieldFlagBitMaskReprOff

The field is excluded from repr output.

When set, the field will not appear in the generic reflection-based repr. By default this flag is off (meaning the field is included in repr).

enumerator kTVMFFIFieldFlagBitMaskCompareOff

The field is excluded from recursive comparison.

When set, the field will not participate in generic reflection-based recursive comparison (RecursiveEq, RecursiveLt, etc.). By default this flag is off (meaning the field is included in comparison).

enumerator kTVMFFIFieldFlagBitMaskHashOff

The field is excluded from recursive hashing.

When set, the field will not participate in generic reflection-based recursive hashing (RecursiveHash). By default this flag is off (meaning the field is included in hashing).

enumerator kTVMFFIFieldFlagBitMaskInitOff

The field is excluded from auto-generated __ffi_init__.

When set, the field will not appear as a parameter of the reflection-based auto-generated constructor. The field must either have a default value or be initialized by the creator (default constructor / UnsafeInit). By default this flag is off (meaning the field is included in init).

enumerator kTVMFFIFieldFlagBitMaskKwOnly

The field is keyword-only in the auto-generated __ffi_init__.

When set, the field can only be provided via the KWARGS calling convention (not as a positional argument) in the auto-generated constructor. This flag is only meaningful when kTVMFFIFieldFlagBitMaskInitOff is not set. By default this flag is off (meaning the field accepts positional arguments).