Skip to content

Commit

Permalink
doc(core): add link to Header document
Browse files Browse the repository at this point in the history
  • Loading branch information
tottoto authored and seanmonstar committed Jan 20, 2024
1 parent 079b092 commit 03079f0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions headers-core/src/lib.rs
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 `HeaderValue`.
/// Encode this type to a [`HeaderValue`].
///
/// This function should be infallible. Any errors converting to a
/// `HeaderValue` should have been caught when parsing or constructing
Expand Down

0 comments on commit 03079f0

Please sign in to comment.