Requirements and specs for containers component

[awillenbuecher-xq-tec]

Requirements for Rust containers in general, and for vector and queue in particular.

I had to change the directory structure under docs/ to comply with the hierarchy checks of score_metamodel.

Pre-Review Checklist for the PR Author

• PR title is short, expressive and meaningful
• Commits are properly organized
• Relevant issues are linked in the References section

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Public API is documented
• PR title describes the changes

Post-review Checklist for the PR Author

• All open points are addressed and tracked via issues

References

Closes #20

[github-actions]

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.4.2) and connecting to it...
INFO: Invocation ID: 3ed05ec3-4530-4e4a-aae8-f2d96f9c6be7
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
DEBUG: Rule 'rust_qnx8_toolchain+' indicated that a canonical reproducible form can be obtained by modifying arguments integrity = "sha256-eQOopREOYCL5vtTb6c1cwZrql4GVrJ1FqgxarQRe1xs="
DEBUG: Repository rust_qnx8_toolchain+ instantiated at:
  <builtin>: in <toplevel>
Repository rule http_archive defined at:
  /home/runner/.bazel/external/bazel_tools/tools/build_defs/repo/http.bzl:431:31: in <toplevel>
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'aspect_rules_lint', the root module requires module version [email protected], but got [email protected] in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
WARNING: For repository 'buildifier_prebuilt', the root module requires module version [email protected], but got [email protected] in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (27 packages loaded, 9 targets configured)

Analyzing: target //:license-check (127 packages loaded, 869 targets configured)

Analyzing: target //:license-check (136 packages loaded, 2294 targets configured)

Analyzing: target //:license-check (142 packages loaded, 2567 targets configured)

Analyzing: target //:license-check (147 packages loaded, 2616 targets configured)

Analyzing: target //:license-check (151 packages loaded, 4747 targets configured)

INFO: Analyzed target //:license-check (152 packages loaded, 4876 targets configured).
[11 / 14] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
INFO: From Generating Dash formatted dependency file ...:
WARNING: No packages found in Cargo.lock.
INFO: Successfully converted 0 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 24.766s, Critical Path: 0.41s
INFO: 14 processes: 5 disk cache hit, 9 internal.
INFO: Build completed successfully, 14 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

[github-actions]

The created documentation from the pull request is available at: docu-html

[pawelrutkaq]

Also, once we fix points, we need a Safety and Security member to review afaik.

[pawelrutkaq]

why we change structore ? We are in baselib rust so second folder (baselib_rust) does not seems to be neeeded

[pawelrutkaq]

OVerall structure is not according to https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/component_name/docs/index.html or ?

[pawelrutkaq]

inline-storage may be not clear in this req imho. So maybe we shall first heave a req for InlineStorage?

[pawelrutkaq]

There is also a need to write somewhere what has to realize ABI compatibility (even though is linked in non-functional maybe it's cleaner when its explicit there and not hidden after N links?)

[pawelrutkaq]

Should that satisfy also ABI req ?

[pawelrutkaq]

does thta need to be done, and also manually ? maybe @4og knows ?

[pawelrutkaq]

LGTM as a starting point. Currently topic of modules documentation is bit open and a lot of things are not clear. We will fix it in #10