Class swarmauri_core.state.IState.IState

swarmauri_core.state.IState.IState

Bases: ABC

read abstractmethod

read()

Reads and returns the current state as a dictionary.

Source code in swarmauri_core/state/IState.py

@abstractmethod
def read(self) -> Dict[str, Any]:
    """
    Reads and returns the current state as a dictionary.
    """

write abstractmethod

write(data)

Replaces the current state with the given data.

Source code in swarmauri_core/state/IState.py

@abstractmethod
def write(self, data: Dict[str, Any]) -> None:
    """
    Replaces the current state with the given data.
    """

update abstractmethod

update(data)

Updates the state with the given data.

Source code in swarmauri_core/state/IState.py

@abstractmethod
def update(self, data: Dict[str, Any]) -> None:
    """
    Updates the state with the given data.
    """

reset abstractmethod

reset()

Resets the state to its initial state.

Source code in swarmauri_core/state/IState.py

@abstractmethod
def reset(self) -> None:
    """
    Resets the state to its initial state.
    """