Struct holochain::conductor::Cell

pub struct Cell<Api = CellConductorApi, P2pCell = HolochainP2pDna> where
    Api: CellConductorApiT,
    P2pCell: HolochainP2pDnaT,  { /* private fields */ }

A Cell is a grouping of the resources necessary to run workflows on behalf of an agent. It does not have a lifetime of its own aside from the lifetimes of the resources which it holds references to. Any work it does is through running a workflow, passing references to the resources needed to complete that workflow.

A Cell is guaranteed to contain a Source Chain which has undergone Genesis.

The [Conductor] manages a collection of Cells, and will call functions on the Cell when a Conductor API method is called (either a CellConductorApi or an [AppInterfaceApi])

Implementations

impl Cell

pub async fn create(
    id: CellId,
    conductor_handle: ConductorHandle,
    space: Space,
    holochain_p2p_cell: HolochainP2pDna,
    managed_task_add_sender: Sender<ManagedTaskAdd>,
    managed_task_stop_broadcaster: Sender<()>
) -> Result<(Self, InitialQueueTriggers), CellError>

Constructor for a Cell, which ensure the Cell is fully initialized before returning.

If it hasn’t happened already, a SourceChain will be created, and genesis will be run. If these have already happened, those steps are skipped.

No Cell will be created if the SourceChain is not ready to be used.

pub async fn genesis<Ribosome>(
    id: CellId,
    conductor_handle: ConductorHandle,
    authored_env: DbWrite<DbKindAuthored>,
    dht_env: DbWrite<DbKindDht>,
    ribosome: Ribosome,
    membrane_proof: Option<SerializedBytes>
) -> Result<(), CellError> where
    Ribosome: RibosomeT + Send + 'static, 

Performs the Genesis workflow the Cell, ensuring that its initial elements are committed. This is a prerequisite for any other interaction with the SourceChain

pub fn id(&self) -> &CellId

Accessor

pub fn holochain_p2p_dna(&self) -> &HolochainP2pDna

Access a network sender that is partially applied to this cell’s DnaHash/AgentPubKey

pub async fn handle_holochain_p2p_event(
    &self,
    evt: HolochainP2pEvent
) -> Result<(), CellError>

Entry point for incoming messages from the network that need to be handled

pub async fn call_zome(
    &self,
    call: ZomeCall,
    workspace_lock: Option<SourceChainWorkspace>
) -> Result<ZomeCallResult, CellError>

Function called by the Conductor

pub async fn cleanup(&self) -> Result<(), CellError>

Clean up long-running managed tasks.

Trait Implementations

impl Debug for Cell

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Cell

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Cell<CellConductorApi, HolochainP2pDna>> for Cell

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.