Source code for guppylang.std.mem

"""Utilities for advanced usage of ownership and borrowing."""

from collections.abc import Callable
from typing import no_type_check

from guppylang_internals.decorator import custom_function
from guppylang_internals.std._internal.compiler.mem import WithOwnedCompiler
from guppylang_internals.std._internal.compiler.prelude import MemSwapCompiler

from guppylang import guppy
from guppylang.std.lang import owned

T = guppy.type_var("T", copyable=False, droppable=False)
Out = guppy.type_var("Out", copyable=False, droppable=False)




@custom_function(MemSwapCompiler())
@no_type_check
def mem_swap(x: T, y: T) -> None:
    """Swaps the values of two variables."""





@custom_function(WithOwnedCompiler())
@no_type_check
def with_owned(val: T, f: Callable[[T @ owned], tuple[Out, T]]) -> Out:
    """Runs a closure where the borrowed argument is promoted to an owned one.

    The closure should return two values:

    * A generic return value that will be passed through.
    * Another value of type `T` that is written back into the borrowed place. This can
      either be the original passed value, or a new value of the same type that was
      created in the closure.

    Pretending that `val` is a pointer, this would be equivalent to the following
    operation in Rust/C: ``(out, *val) = f(*val)``
    """