For the complete documentation index, see llms.txt. Markdown versions of all pages are available by appending .md to any URL (e.g. /get-started.md).
Mojo trait
OptionalPointer
Abstracts over nullable pointers, providing a uniform interface for NonNullPointer and NullPointer.
Implementors are DevicePassable, so a generic OptionalPointer can be
passed straight to a kernel; a NullPointer adds no kernel argument.
Implemented traits
AnyType,
Copyable,
Deinitable,
DevicePassable,
ImplicitlyCopyable,
Movable,
RegisterPassable,
TrivialRegisterPassable
comptime members
address_space
comptime address_space
dtype
comptime dtype
is_null
comptime is_null
Required methods
value
def value(self) -> Pointer[Scalar[Self.dtype], ImmutAnyOrigin, address_space=Self.address_space]
Returns:
Pointer[Scalar[_Self.dtype], ImmutAnyOrigin, address_space=_Self.address_space]