Igium.Errors

Location: work / Software / Igium.Errors

Igium Error Registry

Document Status

This document has been depreciated.

Abstract

This page represents a normative registry of all codespaces and codes of errors produced by any Igium software. An error code indicates both the source of the error and it's meaning. Every codepoint within the Igium source code where an error is generated or proxied from external executable code must provide a full code that is unique to the complete Igium codebase.

Igium error codes imply basic semantics and are built in the following way (each lower-case character represents one hexdecimal digit; each group of same lower-case characters represents a semantic entity, as described below):

IEdddddeee-irppppnnnn

Character Sequence Category Name Description
EI Marker Immutable Igium Error Signature A mandatory prefix for all Igium error codes.
ddddd Error Meaning Error Domain Code Defines semantical scopes for errors per source code purpose; unique within the Igium error registry.
eee Error Meaning Error Semantics Code Identifies the meaning of the error; unique within the error domain.
- Marker Immutable Error Source Prefix A mandatory separator between the error meaning and error source part of the error code.
i Error Source Error Source Infrastructure Role Identifes the type of the error source in terms of source code role in the application infrastructure; unique within the Igium error registry.
r Error Source Error Source Reusability Intent Identifes the type of the error source in terms of source code reusability of the initial source of the error; unique within the Igium error registry.
pppp Error Source Project Code Project-level source scoping; represents an identifier that is assigned by this registry to either an Igium project or an external API/service/library; unique for each of the error source reusability intents r.
nnnn Error Source Error Instance Code Code-level source-scoping; identifies the exact codepoint within the Igium codebase that is generating or proxying the error; unique within the project.

Error Source Infrastructure Role Codes

Code Sample Name Description
0 IEdddddeee-0rppppnnnn Natalis Errors generated by source code usable both server-side and client-side.
1 IEdddddeee-1rppppnnnn Xenesio Errors generated by source code usable client-side only.
2 IEdddddeee-2rppppnnnn Dion Errors generated by source code usable server-side only.

Error Source Reusability Intent Codes

Code Sample Name Description
0 IEdddddeee-i0ppppnnnn Framework Errors generated by framework source code that is reusable by other projects via project dependency, e.g. .NET Framework, nodejs framework, Primordial Blocks framework.
1 IEdddddeee-i1ppppnnnn Public API Errors generated by source code that is reusable by other projects via publically exposed API, e.g. over REST.
2 IEdddddeee-i2ppppnnnn Application Errors generated by application source code that is not reusable by other projects, e.g. a .NET executable, a nodejs server application, a client-side web application.

Framework Codes

Code Sample Name Description
0000 IEdddddeee-i00000nnnn Primordial Blocks The Primordial Blocks JavaScript framework.

API Codes

Code Sample Name Description

Application Codes

Code Sample Name Description
0000 IEdddddeee-i20000nnnn zen The Primordial Blocks "zen" test web application.

Error Codes and Error Domain Codes

Domain Code Error Code Full Error Code Sample Domain Exception Signature Description
00000 IE00000eee-irppppnnnn Global Universally applicable Igium errors, e.g. "Not implemented".
00001 IE00001eee-irppppnnnn System Errors generated by system infrastructur source code, e.g. "Unsupported running environment".
00001 000 IE00001000-irppppnnnn Unsupported running environment Mandatory environment requirements are not met, and code execution cannot continue.
00002 IE00002eee-irppppnnnn Configuration Errors generated by source code that loads and parses configuration data, e.g. "Configuration validation failed".
00003 IE00003eee-irppppnnnn Schema Errors generated by source code that parses schema definitions and validates data upon schema, e.g. "Invalid schema definition".
00004 IE00004eee-irppppnnnn Options Errors generated by source code that parses command line options, e.g. "Option is required".