Documentation

reflect.class.Field

One field of a class: its name, its declared type, and its schema metadata.

Reference version

Signature

class reflect.class.Field

One field of a class: its name, its declared type, and its schema metadata.

A descriptor from reflect.AnyClass.list_fields, get_field or find_field is bound to the instance it came from, so value can read it; one from reflect.Class.fields() describes the type only and is ownerless.

Source:<builtin>/reflect/ns_class/class.bamlbytes 321–1262

Fields

name

string

_owner

unknown | null

Present only for handles returned from reflect.AnyClass.list_fields, get_field or find_field. Type-side descriptors returned by reflect.Class.fields() are intentionally ownerless.

Instance methods

function

metadata

(self) -> reflect.Meta throws never

This field's schema metadata. Same value as the meta field.

function

value

<T>(self) -> T | null throws reflect.errors.TypeMismatch

Read this field from its bound owner. An ownerless type-side descriptor returns null.

Implementations

reflect.AnyClass for T

Instance methods

function

attributes

(self) -> reflect.Meta throws never

The class declaration's schema metadata, or empty metadata when the runtime type is not a class.

function

find

<T>(self, name: string) -> T | null throws reflect.errors.TypeMismatch

Read the field called name as T, or null if this value's class declares no such field. A present field holding null also reads as null; use has_field or get<T?> to tell the two apart.

Throws

  • reflect.errors.TypeMismatch if the field's value is not a T.
function

find_field

(self, name: string) -> reflect.class.Field | null throws never

A value-bound handle to the field called name, or null if this value's class declares no such field.

function

get

<T>(self, name: string) -> T throws reflect.errors.NotFound | reflect.errors.TypeMismatch

Read the field called name as T. Read a nullable field with a nullable T (get<int?>). find returns null for a missing field instead of throwing.

Throws

  • reflect.errors.NotFound if this value's class declares no field called name.
  • reflect.errors.TypeMismatch if the field's value is not a T.
function

get_field

(self, name: string) -> reflect.class.Field throws reflect.errors.NotFound

A value-bound handle to the field called name. find_field returns null instead of throwing.

Throws

  • reflect.errors.NotFound if this value's class declares no field called name.
function

has_field

(self, name: string) -> bool throws never

Whether this value's runtime class declares a field called name. false when the runtime type is not a class.

function

list_fields

(self) -> reflect.class.Field[] throws never

Reflected fields bound to this value for Field.value<T>().

function

name

(self) -> string throws never

The rendered name of this value's concrete runtime type.

function

type

(self) -> reflect.Type throws never

This value's concrete runtime type.

Source:<builtin>/reflect/reflect.bamlbytes 14431–14461