Skip to content

doc(core): Header encode method convert header to HeaderValue #161

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

Merged
merged 3 commits into from
Jan 20, 2024
Merged

doc(core): Header encode method convert header to HeaderValue #161

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
490b6f3
doc(core): Header encode method convert header to HeaderValue
tottoto Jan 19, 2024
7b91e07
doc(core): add link to Header document
tottoto Jan 19, 2024
f635a17
doc(core): add detailed document to Header encode method
tottoto Jan 19, 2024
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: 2 additions & 2 deletions headers-core/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ pub trait Header {
/// The name of this header.
fn name() -> &'static HeaderName;

/// Decode this type from an iterator of `HeaderValue`s.
/// Decode this type from an iterator of [`HeaderValue`]s.
fn decode<'i, I>(values: &mut I) -> Result<Self, Error>
where
Self: Sized,
I: Iterator<Item = &'i HeaderValue>;

/// Encode this type to a `HeaderMap`.
/// Encode this type to a [`HeaderValue`].
Copy link
Member

@seanmonstar seanmonstar Jan 19, 2024

Choose a reason for hiding this comment

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

Ah, well, sorta. The argument is a container of HeaderValues. Normally, it will be an private type that's like an Entry. But since it's generic, unit tests could just pass a Vec<_>.

Copy link
Contributor Author

@tottoto tottoto Jan 19, 2024

Choose a reason for hiding this comment

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

Added a detailed document, which would be more helpful.

///
/// This function should be infallible. Any errors converting to a
/// `HeaderValue` should have been caught when parsing or constructing
Expand Down