Skip to content

Implement slice(&self, range: impl RangeBounds<usize>) for HeaderValue #810

Open

Description

@pyrrho

NB. I initially opened this issue suggesting implementing std::ops::Index instead of a slice method. That original proposal wouldn't work because the trait would always returns a &HeaderValue (a &<Self as Index>::Output) and I'm proposing a method that returns an owned HeaderValue.

My motivation for this is to simplify handling list-based header values in a way that avoids copying the HeaderValue's data. Consider If-None-Match, which may contain multiple comma-separated entity-tags, or Cookies which may contain multiple semicolon-separated cookie-pairs. In both cases, it's necessary to operate on individual values within the list, and sub-slicing is a natural choice;

let inm = HeaderValue::from_static(
    r#"If-None-Match: W/"67ab43", "54ed21", "7892dd""#,
);
assert_eq!(&inm.as_bytes()[15 .. 25], br#"W/"67ab43""#);
assert_eq!(&inm.as_bytes()[27 .. 35], br#""54ed21""#);
assert_eq!(&inm.as_bytes()[37 .. 45], br#""7892dd""#);

The above works well if 1. you can limit operations to &[u8]s and 2. you can manage the lifetime of the borrowed-from HeaderValue. Both of those limitations seem unnecessary given HeaderValue's Arc-like memory characteristic, so it's more natural to my mind to allow something like the below,

let inm = HeaderValue::from_static(
    r#"If-None-Match: W/"67ab43", "54ed21", "7892dd""#,
);
assert_eq!(inm.slice(15 .. 25), HeaderValue::from_static(r#"W/"67ab43""#));
assert_eq!(inm.slice(27 .. 35), HeaderValue::from_static(r#""54ed21""#));
assert_eq!(inm.slice(37 .. 45), HeaderValue::from_static(r#""7892dd""#));

This would be a relatively simple change to make using Bytes::slice to do the heavy lifting.

I haven't put together a PR for the above yet because I see two open questions that I feel a maintainer may want to weigh in on.

First is whether or not this should be done at all. Returning a HeaderValue from a method named slice (rather than a &HeaderValue) may be surprising in the broader context. It would also implicitly codify the use of Bytes — or some other Arc-like memory management system — in the type's interface. I don't see either of these as blockers, given from_maybe_shared is precedent for both, and HeaderValue has been backed by Bytes for years now.

Second, and maybe more interesting, is whether this kind of interface would be better or worse than directly exposing the underlying Bytes object as per #459. Rather than offering a HeaderValue::slice method, consumers could directly call Bytes::slice, e.g.

let inm = HeaderValue::from_static(
    r#"If-None-Match: W/"67ab43", "54ed21", "7892dd""#,
);
let b_inm: Bytes = inm.as_shared();
assert_eq!(b_inm.slice(15 .. 25), Bytes::from_static(r#"W/"67ab43""#));
assert_eq!(b_inm.slice(27 .. 35), Bytes::from_static(r#""54ed21""#));
assert_eq!(b_inm.slice(37 .. 45), Bytes::from_static(r#""7892dd""#));

I'd be happy to put up a PR for either change.

Activity

  1. seanmonstar commented on Dec 26, 2025

    @seanmonstar
    Member

    Thanks for the write-up!

    I think what you're proposing as-is is not going to be possible. The Index trait requires returning a reference, &Self::Output. It couldn't return a sliced HeaderValue, nor create one within the function a return a reference to that (the stack will go out of scope).

    But also in principle, as you mentioned, it could further cement shared byte buffer backing, and that might be undesirable.

  2. pyrrho commented on Dec 26, 2025

    @pyrrho
    Author

    Ah, I did misread the std::ops::Index trait. You're correct that won't work for what I'm proposing. I guess that's why it's Bytes::slice and not impl Index for Bytes.

    I'll make a few adjustments to the issue to change the proposal to a slice method instead of the Index trait.

    .. it could further cement shared byte buffer backing, and that might be undesirable.

    Again, as a (singular, individual, possibly non-representative) consumer of this library, I don't mind that characteristic. I'm not a maintainer, though, so not my call.

  3. changed the title [-]Implement `std::ops::Index<Range<usize>>` (and friends*) for `HeaderValue`[/-] [+]Implement `slice(&self, range: impl RangeBounds<usize>)` for `HeaderValue`[/+] on Dec 26, 2025
  4. pyrrho commented on Jan 8, 2026

    @pyrrho
    Author

    Noting for the cross-link; #811, plus the cheap cloning of HaderName/Value, would resolve this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions