Skip to content

refactor: keep sketch configuration constants private - #241

Merged
tisonkun merged 1 commit into
apache:mainfrom
tisonkun:codex/hide-configuration-constants
Aug 28, 2026
Merged

refactor: keep sketch configuration constants private#241
tisonkun merged 1 commit into
apache:mainfrom
tisonkun:codex/hide-configuration-constants

Conversation

@tisonkun

Copy link
Copy Markdown
Member

Summary

  • keep the REQ DEFAULT_K, MIN_K, and MAX_K values internal
  • keep the Bloom filter builder's size and hash-count bounds internal while preserving validation behavior
  • document the released Bloom filter API migration in the Unreleased changelog

Rationale

Sketch defaults and validity constraints are already expressed through Default, builders, and fallible construction. The REQ range constants also did not express the complete even-k requirement, while the Bloom filter maximum bit count reflects a serialization-field ceiling rather than a portable allocation guarantee.

Testing

  • cargo x check
  • cargo x test
  • cargo x lint
  • verified that the generated rustdoc item list and search index no longer expose the seven constants

@tisonkun
tisonkun enabled auto-merge (squash) August 28, 2026 15:04
@tisonkun
tisonkun merged commit 25ce9e4 into apache:main Aug 28, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant