actix/actix-net
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-net synced 2024-11-23 22:51:07 +01:00
Code Issues Releases Wiki Activity

slice_ref doc tweaks

Browse Source
This commit is contained in:
Rob Ede 2022-11-07 20:21:57 +00:00
parent 363984ad75
commit 6061a44a22
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
bytestring/src/lib.rs
View File

@ -51,30 +51,29 @@ impl ByteString {
Self(src)
}
/// Returns a slice of self that is equivalent to the given `subset`. Corresponds to [`Bytes::slice_ref`].
/// Returns a byte string that is equivalent to the given `subset`.
///
/// When processing a `ByteString` buffer with other tools, one often gets a
/// `&str` which is in fact a slice of the `ByteString`, i.e. a subset of it.
/// This function turns that `&str` into another `ByteString`, as if one had
/// sliced the `ByteString` with the offsets that correspond to `subset`.
/// When processing a `ByteString` buffer with other tools, one often gets a `&str` which is in
/// fact a slice of the `ByteString`; i.e., a subset of it. This function turns that `&str` into
/// another `ByteString`, as if one had sliced the `ByteString` with the offsets that correspond
/// to `subset`.
///
/// Corresponds to [`Bytes::slice_ref`].
///
/// This operation is `O(1)`.
///
/// # Panics
/// Requires that the given `subset` str is in fact contained within the `ByteString` buffer;
/// otherwise this function will panic.
///
/// # Examples
///
/// ```
/// use bytestring::ByteString;
///
/// # use bytestring::ByteString;
/// let string = ByteString::from_static(" foo ");
/// let subset = string.trim();
/// let substring = string.slice_ref(subset);
/// assert_eq!(substring, "foo");
/// ```
///
/// # Panics
///
/// Requires that the given `subset` str is in fact contained within the
/// `ByteString` buffer; otherwise this function will panic.
pub fn slice_ref(&self, subset: &str) -> Self {
Self(self.0.slice_ref(subset.as_bytes()))
}