Struct organelle::Sheath

pub struct Sheath<N> where
    N: Neuron + Sized + 'static,  { /* fields omitted */ }

soma used to wrap a Axon and a soma specialized with Neuron

Methods

impl<N> Sheath<N> where
    N: Neuron + Sized + 'static, 

fn new(
    nucleus: N,
    inputs: Vec<Dendrite<N::Synapse>>,
    outputs: Vec<Dendrite<N::Synapse>>
) -> Result<Self>

wrap a nucleus and constrain the axon

Trait Implementations

impl<N> Soma for Sheath<N> where
    N: Neuron, 

type Signal = N::Signal

user-defined message to be passed between somas

type Synapse = N::Synapse

user-defined roles for connections

type Error = N::Error

error when a soma fails to update

fn update(
    self,
    msg: Impulse<Self::Signal, Self::Synapse>
) -> Result<Self, Self::Error>

apply any changes to the soma's state as a result of _msg

fn into_future(
    self,
    reactor: Handle
) -> Box<Future<Item = Result<()>, Error = Error>> where
    Self: 'static, 

convert the soma into a future that can be run on an event loop

fn run(self) -> Result<()> where
    Self: 'static, 

spin up an event loop and run soma