Skip to content

make defacto public fields actually public #1526

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

Closed
sunshowers wants to merge 1 commit into from
Closed

make defacto public fields actually public #1526

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
6 changes: 3 additions & 3 deletions dropshot/src/pagination.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ where
/// Consumers should use
/// [`RequestContext`][crate::handler::RequestContext::page_limit()]
/// to access this value.
Comment on lines 237 to 239
Copy link
Collaborator

@ahl ahl Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about this? I'm not sure I recall the rationale here; perhaps to preserve our ability to change things in the future?

Copy link
Contributor Author

@sunshowers sunshowers Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not possible to preserve the ability without a breaking change, since this is directly exposed in the HTTP endpoint.

Copy link
Collaborator

@davepacheco davepacheco Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mentioned elsewhere but so this is not lost: the reason this is not pub is because it is almost certainly the wrong thing for consumers to read it so it would be a footgun to expose it to them. They should be using page_limit(). (This field is the limit the user (untrusted) may have provided. page_limit() looks at this, but validates it (if specified) and provides a default (if not).)

pub(crate) limit: Option<NonZeroU32>,
pub limit: Option<NonZeroU32>,
}

pub(crate) const PAGINATION_PARAM_SENTINEL: &str =
Expand Down Expand Up @@ -420,8 +420,8 @@ enum PaginationVersion {
/// Parts of the pagination token that actually get serialized
#[derive(Debug, Deserialize, Serialize)]
struct SerializedToken<PageSelector> {
v: PaginationVersion,
page_start: PageSelector,
pub v: PaginationVersion,
pub page_start: PageSelector,
Comment on lines 422 to +424
Copy link
Collaborator

@ahl ahl Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I follow--this type isn't public, right?

Copy link
Contributor Author

@sunshowers sunshowers Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah yeah this type isn't public, my bad

}

/// Construct a serialized page token from a consumer's page selector
Expand Down
Loading