Skip to content

genop 🔗

Generic operation.

GenopMixin 🔗

Mixin providing the Generic operation for a Session.

This mixin is intended to be used in combination with BaseSession and should not be instantiated on its own.

Intended usage

class Session(BaseSession, GenopMixin): ...

genop 🔗

genop(arg_read: list[Arg], arg_write: list[Arg]) -> None

Performs the Generic operation.

Wraps the vaccel_genop() C operation.

Parameters:

Name Type Description Default

arg_read 🔗

 list[Arg]

The input arguments of the operation.

 required

arg_write 🔗

 list[Arg]

The output arguments of the operation. Modified in place.

 required

Raises:

Type Description
RuntimeError

If the Session is uninitialized.
FFIError

If the C operation fails.
Source code in vaccel/ops/genop.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def genop(self, arg_read: list[Arg], arg_write: list[Arg]) -> None:
    """Performs the Generic operation.

    Wraps the `vaccel_genop()` C operation.

    Args:
        arg_read: The input arguments of the operation.
        arg_write: The output arguments of the operation. Modified in place.

    Raises:
        RuntimeError: If the `Session` is uninitialized.
        FFIError: If the C operation fails.
    """
    c_args_read = CList(arg_read)
    c_args_write = CList(arg_write)

    ret = lib.vaccel_genop(
        self._c_ptr,
        c_args_read._c_ptr,
        len(c_args_read),
        c_args_write._c_ptr,
        len(c_args_write),
    )
    if ret:
        raise FFIError(ret, "Generic operation failed")