Skip to content

WIP: Add # Panics documentation to ConfigFile::built_in() #606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
EffortlessSteven wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Draft

WIP: Add # Panics documentation to ConfigFile::built_in() #606

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions crates/diffguard-types/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,10 @@ impl ConfigFile {
///
/// Rules are loaded from `rules/built_in.json` at compile time via `include_str!`.
/// This ensures the JSON is embedded in the binary and avoids any I/O at runtime.
///
/// # Panics
///
/// Panics if `built_in.json` cannot be parsed as valid JSON.
#[must_use]
pub fn built_in() -> Self {
serde_json::from_str(include_str!("rules/built_in.json"))
Expand Down
Loading