pub const DEFAULT_MAX_RESULTS: usize = 5;
pub const MAX_RESULTS_CEILING: usize = 100;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ResolvedLimit {
pub value: usize,
pub requested: usize,
}
impl ResolvedLimit {
pub fn was_clamped(&self) -> bool {
self.requested != self.value
}
pub fn notice(&self) -> Option<String> {
if !self.was_clamped() {
return None;
}
if self.requested == 0 {
return Some("> Note: `max_results` was floored from 0 to the minimum of 1.\n".into());
}
Some(format!(
"> Note: `max_results` was clamped from {requested} to the advertised maximum of {MAX_RESULTS_CEILING}. \
This tool has no pagination — narrow the search with `kinds` / `path` / `repo_name`, or refine the query.\n",
requested = self.requested
))
}
}
pub fn resolve_max_results(requested: usize) -> ResolvedLimit {
ResolvedLimit {
value: requested.clamp(1, MAX_RESULTS_CEILING),
requested,
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn resolve_max_results_clamps_above_ceiling() {
let resolved = resolve_max_results(10_000);
assert_eq!(resolved.value, MAX_RESULTS_CEILING);
assert_eq!(resolved.requested, 10_000);
assert!(resolved.was_clamped());
}
#[test]
fn resolve_max_results_preserves_values_within_bound() {
for n in [1, DEFAULT_MAX_RESULTS, 20, MAX_RESULTS_CEILING] {
let resolved = resolve_max_results(n);
assert_eq!(resolved.value, n);
assert!(!resolved.was_clamped());
assert!(resolved.notice().is_none());
}
}
#[test]
fn resolve_max_results_floors_at_one() {
let resolved = resolve_max_results(0);
assert_eq!(resolved.value, 1);
assert!(resolved.was_clamped());
}
#[test]
fn clamp_notice_states_bound_and_refine_rule() {
let notice = resolve_max_results(500).notice().expect("clamped");
assert!(notice.contains("500"));
assert!(notice.contains(MAX_RESULTS_CEILING.to_string().as_str()));
assert!(notice.contains("kinds"));
assert!(notice.contains("path"));
assert!(notice.contains("no pagination"));
}
}