Supporting Systems

Relevant source files

• src/error.rs
• src/prelude.rs

This document provides an overview of the supporting modules that enable the core I/O functionality in the axio crate. These systems provide essential infrastructure for error handling, convenience imports, and integration with external dependencies. The supporting systems are designed to be minimal and focused, maintaining the crate's no_std compatibility while providing necessary functionality.

For detailed information about error handling mechanisms, see Error Handling. For information about convenience imports and trait re-exports, see Prelude Module.

Supporting Module Architecture

The axio crate relies on two primary supporting modules that work together to enable the core I/O trait functionality. These modules provide a clean separation between error handling concerns and user-facing API convenience.

Supporting Systems Overview

flowchart TD
subgraph subGraph3["Client Code"]
    user_imports["use axio::prelude::*"]
    error_handling["Result"]
end
subgraph subGraph2["Core I/O System"]
    lib_rs["src/lib.rs"]
    traits["Read, Write, Seek, BufRead"]
end
subgraph subGraph1["axio Supporting Systems"]
    error_rs["src/error.rs"]
    prelude_rs["src/prelude.rs"]
end
subgraph subGraph0["External Dependencies"]
    axerrno["axerrno crate"]
end

axerrno --> error_rs
error_rs --> error_handling
error_rs --> lib_rs
lib_rs --> error_handling
lib_rs --> traits
prelude_rs --> user_imports
traits --> prelude_rs

Sources: src/error.rs(L1 - L3)  src/prelude.rs(L1 - L12) 

Module Interaction Flow

The supporting systems create a clear data flow that separates concerns while maintaining a cohesive API surface.

flowchart TD
subgraph subGraph2["Client Usage"]
    trait_methods["trait methods"]
    result_handling["Result handling"]
end
subgraph subGraph1["Import Path"]
    core_traits["BufRead, Read, Seek, Write"]
    prelude_exports["prelude.rs exports"]
    glob_import["use axio::prelude::*"]
end
subgraph subGraph0["Error Path"]
    axerrno_AxError["axerrno::AxError"]
    axerrno_AxResult["axerrno::AxResult"]
    error_rs_Error["error.rs::Error"]
    error_rs_Result["error.rs::Result"]
end

axerrno_AxError --> error_rs_Error
axerrno_AxResult --> error_rs_Result
core_traits --> prelude_exports
error_rs_Result --> result_handling
glob_import --> trait_methods
prelude_exports --> glob_import
trait_methods --> result_handling

Sources: src/error.rs(L1 - L2)  src/prelude.rs(L11) 

Error System Integration

The src/error.rs module serves as a facade layer that re-exports error types from the axerrno crate. This design provides a stable API surface while delegating the actual error handling implementation to the specialized axerrno crate.

The error system provides consistent error handling across all I/O operations without requiring clients to directly depend on the axerrno crate.

Sources: src/error.rs(L1 - L2) 

Prelude System Organization

The src/prelude.rs module provides a convenience layer that re-exports the four core I/O traits. This follows the established Rust pattern of providing a prelude module for commonly used imports.

The prelude exports include:

• BufRead - Buffered reading operations
• Read - Basic reading operations
• Seek - Stream positioning operations
• Write - Basic writing operations

This design allows clients to import all core functionality with a single glob import: use axio::prelude::*.

Sources: src/prelude.rs(L11) 

System Dependencies

The supporting systems maintain minimal external dependencies to preserve the crate's no_std compatibility:

Both supporting systems are designed to be thin facade layers that add minimal overhead while providing essential functionality for the core I/O trait system.

Sources: src/error.rs(L1 - L2)  src/prelude.rs(L1 - L12)