jsl/errors¶

Package name: jsl/errors

Summary¶

Data Types¶

ValueError ¶

Value Error

Constructors¶

Function	Description
ValueError	Constructor for `defstruct ValueError`

Functions¶

Function	Description
ValueError

InstanceTypeError ¶

Exception type for Distinguishing between module and component instances

Constructors¶

Function	Description
InstanceTypeError (+ 1)	Constructor for `defstruct InstanceTypeError`

NotImplementedYet ¶

Constructors¶

Function	Description
NotImplementedYet	Constructor for `defstruct NotImplementedYet`

Functions¶

Function	Description
NotImplementedYet

MisMatchPortError ¶

This exception is thrown when we expect two ports/pins to be of the same type and they aren't

Functions¶

Function	Description
MisMatchPortError

InvalidComponentSupports ¶

This exception is thrown when an Instance lacks supports for a particular bundle type.

Constructors¶

Function	Description
InvalidComponentSupports	Constructor for `defstruct InvalidComponentSupports`

ArgumentError ¶

Constructors¶

Function	Description
ArgumentError	Constructor for `defstruct ArgumentError`

Functions¶

Function	Description
ArgumentError

MaxIterationsExceededError ¶

Constructors¶

Function	Description
MaxIterationsExceededError	Constructor for `defstruct MaxIterationsExceededError`

Functions¶

Function	Description
MaxIterationsExceededError

Definitions¶

ValueError¶

Value Error

public defstruct ValueError <: Exception
    msg: String

msg: String

This exception is intended to be thrown when checking for values that don't meet pre-/post- conditions for a function. This may include invalid values for a particular application.

Constructors¶

ValueError¶

Constructor for defstruct ValueError

public defn ValueError (msg:String)

Functions¶

ValueError¶

public defn ValueError (msg:Printable) -> ValueError

Returns ValueError

InstanceTypeError¶

Exception type for Distinguishing between module and component instances

public defstruct InstanceTypeError <: Exception
    expects: InstanceType
    observed: InstanceType

expects: InstanceType
observed: InstanceType

Constructors¶

InstanceTypeError¶

Constructor for defstruct InstanceTypeError

public defn InstanceTypeError (expects:InstanceType, observed:InstanceType)

InstanceTypeError¶

Constructor for defstruct InstanceTypeError

public defn InstanceTypeError ( -- expects:InstanceType, observed:InstanceType)

NotImplementedYet¶

public defstruct NotImplementedYet <: RuntimeError
    msg: String

msg: String

Constructors¶

NotImplementedYet¶

Constructor for defstruct NotImplementedYet

public defn NotImplementedYet (msg:String)

Functions¶

NotImplementedYet¶

public defn NotImplementedYet (msg:Printable) -> NotImplementedYet

Returns NotImplementedYet

MisMatchPortError¶

This exception is thrown when we expect two ports/pins to be of the same type and they aren't

public defstruct MisMatchPortError <: Exception
    msg: Maybe<String>
    p1: PortType
    p2: PortType

msg: Maybe<String>
p1: PortType
p2: PortType

Functions¶

MisMatchPortError¶

public defn MisMatchPortError (p1:PortType, p2:PortType -- msg:String = ?) -> MisMatchPortError

Returns MisMatchPortError

InvalidComponentSupports¶

This exception is thrown when an Instance lacks supports for a particular bundle type.

public defstruct InvalidComponentSupports <: Exception
    expected-supports: Tuple<String>

expected-supports: Tuple<String>

Constructors¶

InvalidComponentSupports¶

Constructor for defstruct InvalidComponentSupports

public defn InvalidComponentSupports (expected-supports:Tuple<String>)

ArgumentError¶

public defstruct ArgumentError <: Exception
    msg: String

msg: String

Constructors¶

ArgumentError¶

Constructor for defstruct ArgumentError

public defn ArgumentError (msg:String)

Functions¶

ArgumentError¶

public defn ArgumentError (msg:Printable) -> ArgumentError

Returns ArgumentError

MaxIterationsExceededError¶

public defstruct MaxIterationsExceededError <: RuntimeError
    msg: String

msg: String

Constructors¶

MaxIterationsExceededError¶

Constructor for defstruct MaxIterationsExceededError

public defn MaxIterationsExceededError (msg:String)

Functions¶

MaxIterationsExceededError¶

public defn MaxIterationsExceededError (msg:Printable) -> MaxIterationsExceededError

Returns MaxIterationsExceededError