Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 16 variants SelfConnection, NeuronCountOutOfRange, ZeroTimeStep, FrozenMembrane, NeuronIdOutOfRange, DivisorOutOfRange, BadLayerSizes, MissingNeuronType, ProbabilityOutOfRange, PlasticityEnabled, NeuronCountMismatch, SynapseCountMismatch, MixedVoltageGrids, BadCaseName, NeuronNotAtRest, NeuronIdMismatch,
}
Expand description

Crate-level error type.

The network’s fallible functions, Synapse::new, FixedNetwork::try_from and trace::header return Result<T> via this type; nir’s return NirError, the bridge’s and the kernel’s BridgeError, and trace::row a fmt::Result. Infallible accessors return plain values. No unwrap() outside tests (v0.1 lesson); the expects outside them, in nir’s graph assembly and in freeze::module, each follow the check they name, and a NirImport edited after it was built can still reach the assembly’s (NirImport::build_network § Panics).

One variant per rule: a refusal returns the variant of the rule it breaks, and a function’s # Errors names the variants it returns. Not exhaustive: a new rule may add a variant in a minor release. The variants’ order and their integer values (an as cast) are not promised. A call that breaks two rules returns the variant of one of them, and which one is not promised.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

SelfConnection

A synapse from a neuron to itself (Synapse::new, and SpikingNeuralNetwork::add_synapse through it).

§

NeuronCountOutOfRange

A network of no neuron, or of more than 65,535: ids are u16 (SpikingNeuralNetwork::new and from_neurons).

§

ZeroTimeStep

A time step of zero (SpikingNeuralNetwork::new and from_neurons).

§

FrozenMembrane

A neuron whose membrane cannot move at the network’s time step: a membrane time constant of 0 or above 1,000 time steps, where dt_over_tau truncates to 0 (SpikingNeuralNetwork::new and from_neurons).

§

NeuronIdOutOfRange

A neuron id not below the network’s neuron count (SpikingNeuralNetwork::add_synapse).

§

DivisorOutOfRange

A synaptic input divisor of 0 or above 32,767 (SpikingNeuralNetwork::set_synaptic_input_divisor): the step divides by it as an i16.

§

BadLayerSizes

A Feedforward layer list with a layer of no neuron, or whose sizes do not sum to the neuron count (SpikingNeuralNetwork::build_topology).

§

MissingNeuronType

A Balanced ratio that leaves the network no excitatory or no inhibitory neuron (SpikingNeuralNetwork::build_topology).

§

ProbabilityOutOfRange

A Random connectivity or a SmallWorld rewiring probability outside 0 to 1, NaN included (SpikingNeuralNetwork::build_topology).

§

PlasticityEnabled

A network with plasticity enabled, which a FixedNetwork does not have (FixedNetwork::try_from).

§

NeuronCountMismatch

A network whose neuron count is not the FixedNetwork’s N (FixedNetwork::try_from).

§

SynapseCountMismatch

A network whose synapse count is not the FixedNetwork’s S (FixedNetwork::try_from).

§

MixedVoltageGrids

Neurons on more than one voltage grid: a network keeps one (SpikingNeuralNetwork::from_neurons, and trace::header as a guard).

§

BadCaseName

A trace case name that is empty or holds anything but lowercase ASCII letters, digits and - (trace::header).

§

NeuronNotAtRest

A neuron that is not at rest: its membrane off its resting potential, refractory time left, a current or a stamp, none of which LIFNeuron::new and the with_* chain build (SpikingNeuralNetwork::from_neurons).

§

NeuronIdMismatch

A neuron whose id is not its position among the neurons given (SpikingNeuralNetwork::from_neurons).

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Error

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Error

Source§

impl Error for Error

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl PartialEq for Error

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.