Reduce visibility of GlobEntryResult type alias in glob.rs

[coderabbitai]

API Visibility Improvement

GlobEntryResult is currently declared as pub in src/manifest/glob.rs but is only used within this module. The visibility should be reduced to minimise the public API surface.

Location

src/manifest/glob.rs:47

Current Code

pub type GlobEntryResult = std::result::Result<std::path::PathBuf, glob::GlobError>;

Suggested Fix

type GlobEntryResult = std::result::Result<std::path::PathBuf, glob::GlobError>;

Alternatively, if needed elsewhere within the crate:

pub(crate) type GlobEntryResult = std::result::Result<std::path::PathBuf, glob::GlobError>;

Benefits

• Reduces public API surface area
• Improves encapsulation
• Follows Rust best practices for API design
• Makes the module's public interface cleaner

Acceptance Criteria

• Review actual usage of GlobEntryResult throughout the codebase
• Change visibility to private or pub(crate) as appropriate
• Ensure no compilation errors
• Verify no external dependencies on this type

References

• PR: Refactor manifest module into dedicated submodules #168
• Discussion: PR review comment

Requested by: @leynos

[leynos]

@coderabbitai looking at the codebase, is this issue still relevant? If the issue has been fixed in the code, does the documentation reflect this?

If it is still relevant, please provide an assessment of the issue criticality (critical, high, medium or low), based on risk of the issue impacting the user and the anticipated blast radius.

Once a decision has been made, apply the appropriate label.

If the issue is documentation ONLY (i.e., no code changes needed), apply the documentation label in addition to the appropriate criticality label.

Please also provide an impact of the required changes.

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch issue #174 details
gh issue view 174 --json title,body,labels,state,comments --jq '{title: .title, body: .body, state: .state, labels: [.labels[].name], comments: [.comments[] | {author: .author.login, body: .body}]}'

Length of output: 2003

---

🏁 Script executed:

#!/bin/bash
# Check if the file exists and view the relevant section
cat src/manifest/glob.rs

echo "---SEPARATOR---"

# Search for all usages of GlobEntryResult in the codebase
rg -n "GlobEntryResult" --type rust

Length of output: 15454

---

🏁 Script executed:

#!/bin/bash
# Apply the 'low' criticality label to issue #174
gh issue edit 174 --add-label "low"

Length of output: 44

---

@leynos, I've completed the analysis of issue #174:

Issue Status: STILL RELEVANT ✓

The GlobEntryResult type alias at line 47 of src/manifest/glob.rs remains declared as pub:

pub type GlobEntryResult = std::result::Result<std::path::PathBuf, glob::GlobError>;

However, my codebase search confirms it's only used within the same module as a parameter type for the private function process_glob_entry (line 82). No external usages exist.

Criticality Assessment: LOW

Reasoning:

• User Impact Risk: Minimal - This is an API hygiene issue, not a functional defect
• Blast Radius: Very low - The type isn't used outside the module, so changing visibility won't break any code
• Nature: API surface area reduction following Rust best practices

Label Applied

✓ Applied low label

This is not a documentation-only issue - it requires a code change to reduce the type's visibility.

Impact of Required Changes

Minimal impact:

• Change scope: Single-line modification in src/manifest/glob.rs
• Risk: None - no external dependencies on this type
• Recommendation: Change pub type to type (module-private) as suggested in the issue
• Testing required: Basic compilation check; no behaviour change expected
• Breaking change: No (since it's not actually used publicly)

The fix is straightforward and aligns with the principle of least privilege for API design.