+
Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/modules/baselibs/result/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,47 @@
result
######

.. document:: Result Library
:id: doc__result
:status: draft
:safety: ASIL_B
:tags: baselibs_result
:realizes: PROCESS_wp__cmpt_request

.. toctree::
:hidden:

requirements.rst
architecture/index.rst

Abstract
========

This component request proposes the integration of a safe Result library for type-safe error handling and value propagation.

Motivation and Rationale
========================

The Result library shall provide a type-safe mechanism to represent and propagate either a successful value or an error.
Result library will enable explicit error management and support the development of safety-critical features by providing clear value or error propagation paths.
A Result library with type-safe error handling is needed in the S-CORE software platform due to functional dependencies of different features and the need for explicit, reliable error propagation.
There are multiple use-case like logging error messages or comparing on expected error states to trigger other countermeasures.

Specification
=============

The following details and requirements describe the aspects of the current feature in the context of S-CORE.

General considerations
----------------------

The Result library should provide value/error propagation and error handling capabilities:

* :need:`comp_req__result__error_handling`
* :need:`comp_req__result__domain_error_information`
* :need:`comp_req__result__type_safety`
* :need:`comp_req__result__std_integration`
* :need:`comp_req__result__deterministic_behavior`
* :need:`comp_req__result__exception_free_operation`

The component should be extensible in the future to support richer error information and integration with other platform components.
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载