1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
use bytes::Bytes;
use http::header::HeaderName;
use std::borrow::Borrow;
use std::error::Error;
use std::fmt;
use std::marker::PhantomData;
use std::str::FromStr;
use super::encoding::{Ascii, Binary, ValueEncoding};
/// Represents a custom metadata field name.
///
/// `MetadataKey` is used as the [`MetadataMap`] key.
///
/// [`HeaderMap`]: struct.HeaderMap.html
/// [`MetadataMap`]: struct.MetadataMap.html
#[derive(Clone, Eq, PartialEq, Hash)]
#[repr(transparent)]
pub struct MetadataKey<VE: ValueEncoding> {
// Note: There are unsafe transmutes that assume that the memory layout
// of MetadataValue is identical to HeaderName
pub(crate) inner: http::header::HeaderName,
phantom: PhantomData<VE>,
}
/// A possible error when converting a `MetadataKey` from another type.
#[derive(Debug)]
pub struct InvalidMetadataKey {
_priv: (),
}
/// An ascii metadata key.
pub type AsciiMetadataKey = MetadataKey<Ascii>;
/// A binary metadata key.
pub type BinaryMetadataKey = MetadataKey<Binary>;
impl<VE: ValueEncoding> MetadataKey<VE> {
/// Converts a slice of bytes to a `MetadataKey`.
///
/// This function normalizes the input.
pub fn from_bytes(src: &[u8]) -> Result<Self, InvalidMetadataKey> {
match HeaderName::from_bytes(src) {
Ok(name) => {
if !VE::is_valid_key(name.as_str()) {
return Err(InvalidMetadataKey::new());
}
Ok(MetadataKey {
inner: name,
phantom: PhantomData,
})
}
Err(_) => Err(InvalidMetadataKey::new()),
}
}
/// Converts a static string to a `MetadataKey`.
///
/// This function panics when the static string is a invalid metadata key.
///
/// This function requires the static string to only contain lowercase
/// characters, numerals and symbols, as per the HTTP/2.0 specification
/// and header names internal representation within this library.
///
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// // Parsing a metadata key
/// let CUSTOM_KEY: &'static str = "custom-key";
///
/// let a = AsciiMetadataKey::from_bytes(b"custom-key").unwrap();
/// let b = AsciiMetadataKey::from_static(CUSTOM_KEY);
/// assert_eq!(a, b);
/// ```
///
/// ```should_panic
/// # use tonic::metadata::*;
/// // Parsing a metadata key that contains invalid symbols(s):
/// AsciiMetadataKey::from_static("content{}{}length"); // This line panics!
/// ```
///
/// ```should_panic
/// # use tonic::metadata::*;
/// // Parsing a metadata key that contains invalid uppercase characters.
/// let a = AsciiMetadataKey::from_static("foobar");
/// let b = AsciiMetadataKey::from_static("FOOBAR"); // This line panics!
/// ```
///
/// ```should_panic
/// # use tonic::metadata::*;
/// // Parsing a -bin metadata key as an Ascii key.
/// let b = AsciiMetadataKey::from_static("hello-bin"); // This line panics!
/// ```
///
/// ```should_panic
/// # use tonic::metadata::*;
/// // Parsing a non-bin metadata key as an Binary key.
/// let b = BinaryMetadataKey::from_static("hello"); // This line panics!
/// ```
pub fn from_static(src: &'static str) -> Self {
let name = HeaderName::from_static(src);
if !VE::is_valid_key(name.as_str()) {
panic!("invalid metadata key")
}
MetadataKey {
inner: name,
phantom: PhantomData,
}
}
/// Returns a `str` representation of the metadata key.
///
/// The returned string will always be lower case.
#[inline]
pub fn as_str(&self) -> &str {
self.inner.as_str()
}
/// Converts a HeaderName reference to a MetadataKey. This method assumes
/// that the caller has made sure that the header name has the correct
/// "-bin" or non-"-bin" suffix, it does not validate its input.
#[inline]
pub(crate) fn unchecked_from_header_name_ref(header_name: &HeaderName) -> &Self {
unsafe { &*(header_name as *const HeaderName as *const Self) }
}
/// Converts a HeaderName reference to a MetadataKey. This method assumes
/// that the caller has made sure that the header name has the correct
/// "-bin" or non-"-bin" suffix, it does not validate its input.
#[inline]
pub(crate) fn unchecked_from_header_name(name: HeaderName) -> Self {
MetadataKey {
inner: name,
phantom: PhantomData,
}
}
}
impl<VE: ValueEncoding> FromStr for MetadataKey<VE> {
type Err = InvalidMetadataKey;
fn from_str(s: &str) -> Result<Self, InvalidMetadataKey> {
MetadataKey::from_bytes(s.as_bytes()).map_err(|_| InvalidMetadataKey::new())
}
}
impl<VE: ValueEncoding> AsRef<str> for MetadataKey<VE> {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl<VE: ValueEncoding> AsRef<[u8]> for MetadataKey<VE> {
fn as_ref(&self) -> &[u8] {
self.as_str().as_bytes()
}
}
impl<VE: ValueEncoding> Borrow<str> for MetadataKey<VE> {
fn borrow(&self) -> &str {
self.as_str()
}
}
impl<VE: ValueEncoding> fmt::Debug for MetadataKey<VE> {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(self.as_str(), fmt)
}
}
impl<VE: ValueEncoding> fmt::Display for MetadataKey<VE> {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(self.as_str(), fmt)
}
}
impl InvalidMetadataKey {
#[doc(hidden)]
pub fn new() -> InvalidMetadataKey {
InvalidMetadataKey { _priv: () }
}
}
impl<'a, VE: ValueEncoding> From<&'a MetadataKey<VE>> for MetadataKey<VE> {
fn from(src: &'a MetadataKey<VE>) -> MetadataKey<VE> {
src.clone()
}
}
impl<VE: ValueEncoding> From<MetadataKey<VE>> for Bytes {
#[inline]
fn from(name: MetadataKey<VE>) -> Bytes {
Bytes::copy_from_slice(name.inner.as_ref())
}
}
impl<'a, VE: ValueEncoding> PartialEq<&'a MetadataKey<VE>> for MetadataKey<VE> {
#[inline]
fn eq(&self, other: &&'a MetadataKey<VE>) -> bool {
*self == **other
}
}
impl<'a, VE: ValueEncoding> PartialEq<MetadataKey<VE>> for &'a MetadataKey<VE> {
#[inline]
fn eq(&self, other: &MetadataKey<VE>) -> bool {
*other == *self
}
}
impl<VE: ValueEncoding> PartialEq<str> for MetadataKey<VE> {
/// Performs a case-insensitive comparison of the string against the header
/// name
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let content_length = AsciiMetadataKey::from_static("content-length");
///
/// assert_eq!(content_length, "content-length");
/// assert_eq!(content_length, "Content-Length");
/// assert_ne!(content_length, "content length");
/// ```
#[inline]
fn eq(&self, other: &str) -> bool {
self.inner.eq(other)
}
}
impl<VE: ValueEncoding> PartialEq<MetadataKey<VE>> for str {
/// Performs a case-insensitive comparison of the string against the header
/// name
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let content_length = AsciiMetadataKey::from_static("content-length");
///
/// assert_eq!(content_length, "content-length");
/// assert_eq!(content_length, "Content-Length");
/// assert_ne!(content_length, "content length");
/// ```
#[inline]
fn eq(&self, other: &MetadataKey<VE>) -> bool {
other.inner == *self
}
}
impl<'a, VE: ValueEncoding> PartialEq<&'a str> for MetadataKey<VE> {
/// Performs a case-insensitive comparison of the string against the header
/// name
#[inline]
fn eq(&self, other: &&'a str) -> bool {
*self == **other
}
}
impl<'a, VE: ValueEncoding> PartialEq<MetadataKey<VE>> for &'a str {
/// Performs a case-insensitive comparison of the string against the header
/// name
#[inline]
fn eq(&self, other: &MetadataKey<VE>) -> bool {
*other == *self
}
}
impl fmt::Display for InvalidMetadataKey {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("invalid gRPC metadata key name")
}
}
impl Default for InvalidMetadataKey {
fn default() -> Self {
Self::new()
}
}
impl Error for InvalidMetadataKey {}
#[cfg(test)]
mod tests {
use super::{AsciiMetadataKey, BinaryMetadataKey};
#[test]
fn test_from_bytes_binary() {
assert!(BinaryMetadataKey::from_bytes(b"").is_err());
assert!(BinaryMetadataKey::from_bytes(b"\xFF").is_err());
assert!(BinaryMetadataKey::from_bytes(b"abc").is_err());
assert_eq!(
BinaryMetadataKey::from_bytes(b"abc-bin").unwrap().as_str(),
"abc-bin"
);
}
#[test]
fn test_from_bytes_ascii() {
assert!(AsciiMetadataKey::from_bytes(b"").is_err());
assert!(AsciiMetadataKey::from_bytes(b"\xFF").is_err());
assert_eq!(
AsciiMetadataKey::from_bytes(b"abc").unwrap().as_str(),
"abc"
);
assert!(AsciiMetadataKey::from_bytes(b"abc-bin").is_err());
}
}