Documentation

reflect.interface.Implementation

An immutable structural-conformance witness. Values are created only by `reflect.Interface.implementation<I>()`; each `field` call returns a new witness. A structural witness that a runtime-built class implements an interface.

Reference version

Signature

class reflect.interface.Implementation

An immutable structural-conformance witness. Values are created only by reflect.Interface.implementation<I>(); each field call returns a new witness. A structural witness that a runtime-built class implements an interface.

Start one with reflect.Interface.implementation<I>() and link each interface field to the class field satisfying it with field.

Source:<builtin>/reflect/ns_interface/interface.bamlbytes 384–926

Fields

_handle

$rust_type

Instance methods

function

field

(
self,
interface_field: string,
class_field: string | null = …
) -> reflect.interface.Implementation throws reflect.errors.CompilationError

Links interface_field to the class field that satisfies it, defaulting to the field of the same name.

Throws

  • reflect.errors.CompilationError if the interface declares no such field, or the link is not well typed.

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