lib-block is the canonical fixed-size IPC/types crate for block storage
Find a file
Erik Inkinen 59a9ba1f11
All checks were successful
CI / markdown (push) Successful in 3s
CI / test (push) Successful in 13s
Tighten CI markdown policy
2026-05-22 15:10:09 +03:00
.github Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
src fmt: normalize block IPC crate 2026-04-22 08:18:25 +03:00
.editorconfig Initial commit 2026-04-22 04:02:22 +02:00
.gitignore Initial commit 2026-04-22 04:02:22 +02:00
.markdownlint-cli2.yaml Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
ARCHITECTURE.md Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
Cargo.toml Implement lib-block IPC crate 2026-04-22 07:15:45 +03:00
CODE_OF_CONDUCT.md Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
CONTRIBUTING.md Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
LICENSE Initial commit 2026-04-22 04:02:22 +02:00
README.md Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
ROADMAP.md Tighten CI markdown policy 2026-05-22 15:10:09 +03:00
rustfmt.toml Initial commit 2026-04-22 04:02:22 +02:00
SECURITY.md Tighten CI markdown policy 2026-05-22 15:10:09 +03:00

lib-block

lib-block is the canonical fixed-size IPC/types crate for the storage stack storage. It is shared by:.

EriX is a clean-room, capability-based microkernel operating system written entirely in Rust.

Technical requirements are tracked in the EriX requirements, conventions, and project documentation.

See:

  • docs for design documents, specifications, and development plans.
  • Related architecture repositories for kernel, services, libraries, drivers, and integration tooling.

Purpose of This Repository

This repository implements the EriX block library. Its purpose in EriX is to provide reusable block primitives and contracts to EriX components.

Functionally, it exposes the block APIs, validation tests, and documentation used by dependent repositories. The repository keeps the implementation, interface contracts, tests, and documentation for that behavior in one reviewable ownership boundary.

The maintained responsibilities are:

  • expose the lib-block crate API for block behavior used by dependent components
  • keep data formats, constants, and validation helpers documented and tested
  • preserve clean-room, no-external-crate implementation boundaries
  • maintain compatibility expectations for downstream repositories

Clean-Room Policy

EriX follows a strict clean-room philosophy:

  • No external source code may be copied.
  • No external Rust crates are allowed.
  • No code generation tools that embed third-party code.
  • All code must be authored within the project.

Violations will result in rejection of the contribution.

License

All EriX repositories are licensed under the ISC License.

Development Model

EriX development is modular, deterministic, reproducible, authority-explicit, security-first, and self-hosting oriented.

This repository follows the project roadmap and the validation rules documented in its own roadmap.

Validation

  • cargo test
  • cargo fmt
  • strict clippy with warnings denied

Governance Principles

lib-block governance is scoped to reusable block-device contracts shared by dependent repositories.

The scoped governance rules are:

  • It must expose narrow, documented APIs rather than component-specific policy.
  • It keeps wire formats, constants, parsers, and validation helpers deterministic and testable.
  • It preserves clean-room implementation boundaries and does not introduce external crate dependencies.
  • Breaking API or format changes require coordinated updates in every dependent repository.

Library Boundaries

  • lib-block carries no runtime authority by itself; authority is held by callers that use the library.
  • The crate must not hide ambient I/O, allocation policy, or service discovery behind helper APIs.

Contact

Development occurs in EriX organization and discussions happen in issues and design documents.

No decisions are considered valid without documented rationale.

Maintainers can be reached via email: admin@erikinkinen.fi.