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.
Implemented traits
AnyType,
Copyable,
Deinitable,
ImplicitlyCopyable,
Movable,
RegisterPassable,
TrivialRegisterPassable
comptime members
address_space
comptime address_space
dtype
comptime dtype
is_null
comptime is_null
Required methods
__init__
def __init__(out self, *, copy: Self)
Create a new instance of the value by copying an existing one.
Args:
- copy (
_Self): The value to copy.
Returns:
_Self
def __init__(out self, *, deinit move: Self)
Create a new instance of the value by moving the value of another.
Args:
- move (
_Self): The value to move.
Returns:
_Self
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]
Provided methods
copy
def copy(self) -> Self
Explicitly construct a copy of self, a convenience method for Self(copy=self) when the type is inconvenient to write out.
Overriding this method is not allowed.
Returns:
_Self: A copy of this value.