Implement `slice(&self, range: impl RangeBounds<usize>)` for `HeaderValue`
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
Research direction
Start by reviewing HeaderValue's existing shared-storage APIs, then inspect Bytes::slice and the alternative discussed in issue #459. Resolve which interface maintainers want, and consider the range behavior and ownership implications; the work is done when the chosen API is implemented with appropriate coverage and documentation.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Rust
- Stars
- 1.4k
- Forks
- 378
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 5
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from hyperium/http
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
-
Difficulty 3/5 1-2 days Newbie friendliness 58/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
Similar issues
-
Browser (wasm) relay client cannot connect to relays whose URL has a trailing-dot FQDN hostname Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
n0-computer/iroh#4550 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
paritytech/zombienet-sdk#591 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
farion1231/cc-switch#7638 · 1 comment ·
-
onnx-ir re-exports ModelProto and GraphProto but not NodeProto, AttributeProto and AttributeType Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100