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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
#![allow(clippy::upper_case_acronyms)]
use super::encoding::{
Ascii, Binary, InvalidMetadataValue, InvalidMetadataValueBytes, ValueEncoding,
};
use super::key::MetadataKey;
use bytes::Bytes;
use http::header::HeaderValue;
use std::error::Error;
use std::hash::{Hash, Hasher};
use std::marker::PhantomData;
use std::str::FromStr;
use std::{cmp, fmt};
/// Represents a custom metadata field value.
///
/// `MetadataValue` is used as the [`MetadataMap`] value.
///
/// [`HeaderMap`]: struct.HeaderMap.html
/// [`MetadataMap`]: struct.MetadataMap.html
#[derive(Clone)]
#[repr(transparent)]
pub struct MetadataValue<VE: ValueEncoding> {
// Note: There are unsafe transmutes that assume that the memory layout
// of MetadataValue is identical to HeaderValue
pub(crate) inner: HeaderValue,
phantom: PhantomData<VE>,
}
/// A possible error when converting a `MetadataValue` to a string representation.
///
/// Metadata field values may contain opaque bytes, in which case it is not
/// possible to represent the value as a string.
#[derive(Debug)]
pub struct ToStrError {
_priv: (),
}
/// An ascii metadata value.
pub type AsciiMetadataValue = MetadataValue<Ascii>;
/// A binary metadata value.
pub type BinaryMetadataValue = MetadataValue<Binary>;
impl<VE: ValueEncoding> MetadataValue<VE> {
/// Convert a static string to a `MetadataValue`.
///
/// This function will not perform any copying, however the string is
/// checked to ensure that no invalid characters are present.
///
/// For Ascii values, only visible ASCII characters (32-127) are permitted.
/// For Binary values, the string must be valid base64.
///
/// # Panics
///
/// This function panics if the argument contains invalid metadata value
/// characters.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("hello");
/// assert_eq!(val, "hello");
/// ```
///
/// ```
/// # use tonic::metadata::*;
/// let val = BinaryMetadataValue::from_static("SGVsbG8hIQ==");
/// assert_eq!(val, "Hello!!");
/// ```
#[inline]
pub fn from_static(src: &'static str) -> Self {
MetadataValue {
inner: VE::from_static(src),
phantom: PhantomData,
}
}
/// Convert a `Bytes` directly into a `MetadataValue` without validating.
/// For `MetadataValue<Binary>` the provided parameter must be base64
/// encoded without padding bytes at the end.
///
/// # Safety
///
/// This function does NOT validate that illegal bytes are not contained
/// within the buffer.
#[inline]
pub unsafe fn from_shared_unchecked(src: Bytes) -> Self {
MetadataValue {
inner: HeaderValue::from_maybe_shared_unchecked(src),
phantom: PhantomData,
}
}
/// Returns true if the `MetadataValue` has a length of zero bytes.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("");
/// assert!(val.is_empty());
///
/// let val = AsciiMetadataValue::from_static("hello");
/// assert!(!val.is_empty());
/// ```
#[inline]
pub fn is_empty(&self) -> bool {
VE::is_empty(self.inner.as_bytes())
}
/// Converts a `MetadataValue` to a Bytes buffer. This method cannot
/// fail for Ascii values. For Ascii values, `as_bytes` is more convenient
/// to use.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("hello");
/// assert_eq!(val.to_bytes().unwrap().as_ref(), b"hello");
/// ```
///
/// ```
/// # use tonic::metadata::*;
/// let val = BinaryMetadataValue::from_bytes(b"hello");
/// assert_eq!(val.to_bytes().unwrap().as_ref(), b"hello");
/// ```
#[inline]
pub fn to_bytes(&self) -> Result<Bytes, InvalidMetadataValueBytes> {
VE::decode(self.inner.as_bytes())
}
/// Mark that the metadata value represents sensitive information.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let mut val = AsciiMetadataValue::from_static("my secret");
///
/// val.set_sensitive(true);
/// assert!(val.is_sensitive());
///
/// val.set_sensitive(false);
/// assert!(!val.is_sensitive());
/// ```
#[inline]
pub fn set_sensitive(&mut self, val: bool) {
self.inner.set_sensitive(val);
}
/// Returns `true` if the value represents sensitive data.
///
/// Sensitive data could represent passwords or other data that should not
/// be stored on disk or in memory. This setting can be used by components
/// like caches to avoid storing the value. HPACK encoders must set the
/// metadata field to never index when `is_sensitive` returns true.
///
/// Note that sensitivity is not factored into equality or ordering.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let mut val = AsciiMetadataValue::from_static("my secret");
///
/// val.set_sensitive(true);
/// assert!(val.is_sensitive());
///
/// val.set_sensitive(false);
/// assert!(!val.is_sensitive());
/// ```
#[inline]
pub fn is_sensitive(&self) -> bool {
self.inner.is_sensitive()
}
/// Converts a `MetadataValue` to a byte slice. For Binary values, the
/// return value is base64 encoded.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("hello");
/// assert_eq!(val.as_encoded_bytes(), b"hello");
/// ```
///
/// ```
/// # use tonic::metadata::*;
/// let val = BinaryMetadataValue::from_bytes(b"Hello!");
/// assert_eq!(val.as_encoded_bytes(), b"SGVsbG8h");
/// ```
#[inline]
pub fn as_encoded_bytes(&self) -> &[u8] {
self.inner.as_bytes()
}
/// Converts a HeaderValue to a MetadataValue. This method assumes that the
/// caller has made sure that the value is of the correct Ascii or Binary
/// value encoding.
#[inline]
pub(crate) fn unchecked_from_header_value(value: HeaderValue) -> Self {
MetadataValue {
inner: value,
phantom: PhantomData,
}
}
/// Converts a HeaderValue reference to a MetadataValue. This method assumes
/// that the caller has made sure that the value is of the correct Ascii or
/// Binary value encoding.
#[inline]
pub(crate) fn unchecked_from_header_value_ref(header_value: &HeaderValue) -> &Self {
unsafe { &*(header_value as *const HeaderValue as *const Self) }
}
/// Converts a HeaderValue reference to a MetadataValue. This method assumes
/// that the caller has made sure that the value is of the correct Ascii or
/// Binary value encoding.
#[inline]
pub(crate) fn unchecked_from_mut_header_value_ref(header_value: &mut HeaderValue) -> &mut Self {
unsafe { &mut *(header_value as *mut HeaderValue as *mut Self) }
}
}
/// Attempt to convert a byte slice to a `MetadataValue`.
///
/// For Ascii metadata values, If the argument contains invalid metadata
/// value bytes, an error is returned. Only byte values between 32 and 255
/// (inclusive) are permitted, excluding byte 127 (DEL).
///
/// For Binary metadata values this method cannot fail. See also the Binary
/// only version of this method `from_bytes`.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::try_from(b"hello\xfa").unwrap();
/// assert_eq!(val, &b"hello\xfa"[..]);
/// ```
///
/// An invalid value
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::try_from(b"\n");
/// assert!(val.is_err());
/// ```
impl<'a, VE: ValueEncoding> TryFrom<&'a [u8]> for MetadataValue<VE> {
type Error = InvalidMetadataValueBytes;
#[inline]
fn try_from(src: &[u8]) -> Result<Self, Self::Error> {
VE::from_bytes(src).map(|value| MetadataValue {
inner: value,
phantom: PhantomData,
})
}
}
/// Attempt to convert a byte slice to a `MetadataValue`.
///
/// For Ascii metadata values, If the argument contains invalid metadata
/// value bytes, an error is returned. Only byte values between 32 and 255
/// (inclusive) are permitted, excluding byte 127 (DEL).
///
/// For Binary metadata values this method cannot fail. See also the Binary
/// only version of this method `from_bytes`.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::try_from(b"hello\xfa").unwrap();
/// assert_eq!(val, &b"hello\xfa"[..]);
/// ```
///
/// An invalid value
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::try_from(b"\n");
/// assert!(val.is_err());
/// ```
impl<'a, VE: ValueEncoding, const N: usize> TryFrom<&'a [u8; N]> for MetadataValue<VE> {
type Error = InvalidMetadataValueBytes;
#[inline]
fn try_from(src: &[u8; N]) -> Result<Self, Self::Error> {
Self::try_from(src.as_ref())
}
}
/// Attempt to convert a `Bytes` buffer to a `MetadataValue`.
///
/// For `MetadataValue<Ascii>`, if the argument contains invalid metadata
/// value bytes, an error is returned. Only byte values between 32 and 255
/// (inclusive) are permitted, excluding byte 127 (DEL).
///
/// For `MetadataValue<Binary>`, if the argument is not valid base64, an
/// error is returned. In use cases where the input is not base64 encoded,
/// use `from_bytes`; if the value has to be encoded it's not possible to
/// share the memory anyways.
impl<VE: ValueEncoding> TryFrom<Bytes> for MetadataValue<VE> {
type Error = InvalidMetadataValueBytes;
#[inline]
fn try_from(src: Bytes) -> Result<Self, Self::Error> {
VE::from_shared(src).map(|value| MetadataValue {
inner: value,
phantom: PhantomData,
})
}
}
/// Attempt to convert a Vec of bytes to a `MetadataValue`.
///
/// For `MetadataValue<Ascii>`, if the argument contains invalid metadata
/// value bytes, an error is returned. Only byte values between 32 and 255
/// (inclusive) are permitted, excluding byte 127 (DEL).
///
/// For `MetadataValue<Binary>`, if the argument is not valid base64, an
/// error is returned. In use cases where the input is not base64 encoded,
/// use `from_bytes`; if the value has to be encoded it's not possible to
/// share the memory anyways.
impl<VE: ValueEncoding> TryFrom<Vec<u8>> for MetadataValue<VE> {
type Error = InvalidMetadataValueBytes;
#[inline]
fn try_from(src: Vec<u8>) -> Result<Self, Self::Error> {
Self::try_from(src.as_slice())
}
}
/// Attempt to convert a string to a `MetadataValue<Ascii>`.
///
/// If the argument contains invalid metadata value characters, an error is
/// returned. Only visible ASCII characters (32-127) are permitted. Use
/// `from_bytes` to create a `MetadataValue` that includes opaque octets
/// (128-255).
impl<'a> TryFrom<&'a str> for MetadataValue<Ascii> {
type Error = InvalidMetadataValue;
#[inline]
fn try_from(s: &'a str) -> Result<Self, Self::Error> {
s.parse()
}
}
/// Attempt to convert a string to a `MetadataValue<Ascii>`.
///
/// If the argument contains invalid metadata value characters, an error is
/// returned. Only visible ASCII characters (32-127) are permitted. Use
/// `from_bytes` to create a `MetadataValue` that includes opaque octets
/// (128-255).
impl<'a> TryFrom<&'a String> for MetadataValue<Ascii> {
type Error = InvalidMetadataValue;
#[inline]
fn try_from(s: &'a String) -> Result<Self, Self::Error> {
s.parse()
}
}
/// Attempt to convert a string to a `MetadataValue<Ascii>`.
///
/// If the argument contains invalid metadata value characters, an error is
/// returned. Only visible ASCII characters (32-127) are permitted. Use
/// `from_bytes` to create a `MetadataValue` that includes opaque octets
/// (128-255).
impl TryFrom<String> for MetadataValue<Ascii> {
type Error = InvalidMetadataValue;
#[inline]
fn try_from(s: String) -> Result<Self, Self::Error> {
s.parse()
}
}
// is_empty is defined in the generic impl block above
#[allow(clippy::len_without_is_empty)]
impl MetadataValue<Ascii> {
/// Converts a MetadataKey into a `MetadataValue<Ascii>`.
///
/// Since every valid MetadataKey is a valid MetadataValue this is done
/// infallibly.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_key::<Ascii>("accept".parse().unwrap());
/// assert_eq!(val, AsciiMetadataValue::try_from(b"accept").unwrap());
/// ```
#[inline]
pub fn from_key<KeyVE: ValueEncoding>(key: MetadataKey<KeyVE>) -> Self {
key.into()
}
/// Returns the length of `self`, in bytes.
///
/// This method is not available for `MetadataValue<Binary>` because that
/// cannot be implemented in constant time, which most people would probably
/// expect. To get the length of `MetadataValue<Binary>`, convert it to a
/// Bytes value and measure its length.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("hello");
/// assert_eq!(val.len(), 5);
/// ```
#[inline]
pub fn len(&self) -> usize {
self.inner.len()
}
/// Yields a `&str` slice if the `MetadataValue` only contains visible ASCII
/// chars.
///
/// This function will perform a scan of the metadata value, checking all the
/// characters.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("hello");
/// assert_eq!(val.to_str().unwrap(), "hello");
/// ```
pub fn to_str(&self) -> Result<&str, ToStrError> {
self.inner.to_str().map_err(|_| ToStrError::new())
}
/// Converts a `MetadataValue` to a byte slice. For Binary values, use
/// `to_bytes`.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = AsciiMetadataValue::from_static("hello");
/// assert_eq!(val.as_bytes(), b"hello");
/// ```
#[inline]
pub fn as_bytes(&self) -> &[u8] {
self.inner.as_bytes()
}
}
impl MetadataValue<Binary> {
/// Convert a byte slice to a `MetadataValue<Binary>`.
///
/// # Examples
///
/// ```
/// # use tonic::metadata::*;
/// let val = BinaryMetadataValue::from_bytes(b"hello\xfa");
/// assert_eq!(val, &b"hello\xfa"[..]);
/// ```
#[inline]
pub fn from_bytes(src: &[u8]) -> Self {
// Only the Ascii version of try_from can fail.
Self::try_from(src).unwrap()
}
}
impl<VE: ValueEncoding> AsRef<[u8]> for MetadataValue<VE> {
#[inline]
fn as_ref(&self) -> &[u8] {
self.inner.as_ref()
}
}
impl<VE: ValueEncoding> fmt::Debug for MetadataValue<VE> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
VE::fmt(&self.inner, f)
}
}
impl<KeyVE: ValueEncoding> From<MetadataKey<KeyVE>> for MetadataValue<Ascii> {
#[inline]
fn from(h: MetadataKey<KeyVE>) -> MetadataValue<Ascii> {
MetadataValue {
inner: h.inner.into(),
phantom: PhantomData,
}
}
}
macro_rules! from_integers {
($($name:ident: $t:ident => $max_len:expr),*) => {$(
impl From<$t> for MetadataValue<Ascii> {
fn from(num: $t) -> MetadataValue<Ascii> {
MetadataValue {
inner: HeaderValue::from(num),
phantom: PhantomData,
}
}
}
#[test]
fn $name() {
let n: $t = 55;
let val = AsciiMetadataValue::from(n);
assert_eq!(val, &n.to_string());
let n = ::std::$t::MAX;
let val = AsciiMetadataValue::from(n);
assert_eq!(val, &n.to_string());
}
)*};
}
from_integers! {
// integer type => maximum decimal length
// u8 purposely left off... AsciiMetadataValue::from(b'3') could be confusing
from_u16: u16 => 5,
from_i16: i16 => 6,
from_u32: u32 => 10,
from_i32: i32 => 11,
from_u64: u64 => 20,
from_i64: i64 => 20
}
#[cfg(target_pointer_width = "16")]
from_integers! {
from_usize: usize => 5,
from_isize: isize => 6
}
#[cfg(target_pointer_width = "32")]
from_integers! {
from_usize: usize => 10,
from_isize: isize => 11
}
#[cfg(target_pointer_width = "64")]
from_integers! {
from_usize: usize => 20,
from_isize: isize => 20
}
#[cfg(test)]
mod from_metadata_value_tests {
use super::*;
use crate::metadata::map::MetadataMap;
#[test]
fn it_can_insert_metadata_key_as_metadata_value() {
let mut map = MetadataMap::new();
map.insert(
"accept",
MetadataKey::<Ascii>::from_bytes(b"hello-world")
.unwrap()
.into(),
);
assert_eq!(
map.get("accept").unwrap(),
AsciiMetadataValue::try_from(b"hello-world").unwrap()
);
}
}
impl FromStr for MetadataValue<Ascii> {
type Err = InvalidMetadataValue;
#[inline]
fn from_str(s: &str) -> Result<MetadataValue<Ascii>, Self::Err> {
HeaderValue::from_str(s)
.map(|value| MetadataValue {
inner: value,
phantom: PhantomData,
})
.map_err(|_| InvalidMetadataValue::new())
}
}
impl<VE: ValueEncoding> From<MetadataValue<VE>> for Bytes {
#[inline]
fn from(value: MetadataValue<VE>) -> Bytes {
Bytes::copy_from_slice(value.inner.as_bytes())
}
}
impl<'a, VE: ValueEncoding> From<&'a MetadataValue<VE>> for MetadataValue<VE> {
#[inline]
fn from(t: &'a MetadataValue<VE>) -> Self {
t.clone()
}
}
// ===== ToStrError =====
impl ToStrError {
pub(crate) fn new() -> Self {
ToStrError { _priv: () }
}
}
impl fmt::Display for ToStrError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("failed to convert metadata to a str")
}
}
impl Error for ToStrError {}
impl Hash for MetadataValue<Ascii> {
fn hash<H: Hasher>(&self, state: &mut H) {
self.inner.hash(state)
}
}
impl Hash for MetadataValue<Binary> {
fn hash<H: Hasher>(&self, state: &mut H) {
match self.to_bytes() {
Ok(b) => b.hash(state),
Err(e) => e.hash(state),
}
}
}
// ===== PartialEq / PartialOrd =====
impl<VE: ValueEncoding> PartialEq for MetadataValue<VE> {
#[inline]
fn eq(&self, other: &MetadataValue<VE>) -> bool {
// Note: Different binary strings that after base64 decoding
// will count as the same value for Binary values. Also,
// different invalid base64 values count as equal for Binary
// values.
VE::values_equal(&self.inner, &other.inner)
}
}
impl<VE: ValueEncoding> Eq for MetadataValue<VE> {}
impl<VE: ValueEncoding> PartialOrd for MetadataValue<VE> {
#[inline]
fn partial_cmp(&self, other: &MetadataValue<VE>) -> Option<cmp::Ordering> {
Some(self.cmp(other))
}
}
impl<VE: ValueEncoding> Ord for MetadataValue<VE> {
#[inline]
fn cmp(&self, other: &Self) -> cmp::Ordering {
self.inner.cmp(&other.inner)
}
}
impl<VE: ValueEncoding> PartialEq<str> for MetadataValue<VE> {
#[inline]
fn eq(&self, other: &str) -> bool {
VE::equals(&self.inner, other.as_bytes())
}
}
impl<VE: ValueEncoding> PartialEq<[u8]> for MetadataValue<VE> {
#[inline]
fn eq(&self, other: &[u8]) -> bool {
VE::equals(&self.inner, other)
}
}
impl<VE: ValueEncoding> PartialOrd<str> for MetadataValue<VE> {
#[inline]
fn partial_cmp(&self, other: &str) -> Option<cmp::Ordering> {
self.inner.partial_cmp(other.as_bytes())
}
}
impl<VE: ValueEncoding> PartialOrd<[u8]> for MetadataValue<VE> {
#[inline]
fn partial_cmp(&self, other: &[u8]) -> Option<cmp::Ordering> {
self.inner.partial_cmp(other)
}
}
impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for str {
#[inline]
fn eq(&self, other: &MetadataValue<VE>) -> bool {
*other == *self
}
}
impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for [u8] {
#[inline]
fn eq(&self, other: &MetadataValue<VE>) -> bool {
*other == *self
}
}
impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for str {
#[inline]
fn partial_cmp(&self, other: &MetadataValue<VE>) -> Option<cmp::Ordering> {
self.as_bytes().partial_cmp(other.inner.as_bytes())
}
}
impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for [u8] {
#[inline]
fn partial_cmp(&self, other: &MetadataValue<VE>) -> Option<cmp::Ordering> {
self.partial_cmp(other.inner.as_bytes())
}
}
impl<VE: ValueEncoding> PartialEq<String> for MetadataValue<VE> {
#[inline]
fn eq(&self, other: &String) -> bool {
*self == other[..]
}
}
impl<VE: ValueEncoding> PartialOrd<String> for MetadataValue<VE> {
#[inline]
fn partial_cmp(&self, other: &String) -> Option<cmp::Ordering> {
self.inner.partial_cmp(other.as_bytes())
}
}
impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for String {
#[inline]
fn eq(&self, other: &MetadataValue<VE>) -> bool {
*other == *self
}
}
impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for String {
#[inline]
fn partial_cmp(&self, other: &MetadataValue<VE>) -> Option<cmp::Ordering> {
self.as_bytes().partial_cmp(other.inner.as_bytes())
}
}
impl<'a, VE: ValueEncoding> PartialEq<MetadataValue<VE>> for &'a MetadataValue<VE> {
#[inline]
fn eq(&self, other: &MetadataValue<VE>) -> bool {
**self == *other
}
}
impl<'a, VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for &'a MetadataValue<VE> {
#[inline]
fn partial_cmp(&self, other: &MetadataValue<VE>) -> Option<cmp::Ordering> {
(**self).partial_cmp(other)
}
}
impl<'a, VE: ValueEncoding, T: ?Sized> PartialEq<&'a T> for MetadataValue<VE>
where
MetadataValue<VE>: PartialEq<T>,
{
#[inline]
fn eq(&self, other: &&'a T) -> bool {
*self == **other
}
}
impl<'a, VE: ValueEncoding, T: ?Sized> PartialOrd<&'a T> for MetadataValue<VE>
where
MetadataValue<VE>: PartialOrd<T>,
{
#[inline]
fn partial_cmp(&self, other: &&'a T) -> Option<cmp::Ordering> {
self.partial_cmp(*other)
}
}
impl<'a, VE: ValueEncoding> PartialEq<MetadataValue<VE>> for &'a str {
#[inline]
fn eq(&self, other: &MetadataValue<VE>) -> bool {
*other == *self
}
}
impl<'a, VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for &'a str {
#[inline]
fn partial_cmp(&self, other: &MetadataValue<VE>) -> Option<cmp::Ordering> {
self.as_bytes().partial_cmp(other.inner.as_bytes())
}
}
#[test]
fn test_debug() {
let cases = &[
("hello", "\"hello\""),
("hello \"world\"", "\"hello \\\"world\\\"\""),
("\u{7FFF}hello", "\"\\xe7\\xbf\\xbfhello\""),
];
for &(value, expected) in cases {
let val = AsciiMetadataValue::try_from(value.as_bytes()).unwrap();
let actual = format!("{:?}", val);
assert_eq!(expected, actual);
}
let mut sensitive = AsciiMetadataValue::from_static("password");
sensitive.set_sensitive(true);
assert_eq!("Sensitive", format!("{:?}", sensitive));
}
#[test]
fn test_is_empty() {
fn from_str<VE: ValueEncoding>(s: &str) -> MetadataValue<VE> {
MetadataValue::<VE>::unchecked_from_header_value(s.parse().unwrap())
}
assert!(from_str::<Ascii>("").is_empty());
assert!(from_str::<Binary>("").is_empty());
assert!(!from_str::<Ascii>("a").is_empty());
assert!(!from_str::<Binary>("a").is_empty());
assert!(!from_str::<Ascii>("=").is_empty());
assert!(from_str::<Binary>("=").is_empty());
assert!(!from_str::<Ascii>("===").is_empty());
assert!(from_str::<Binary>("===").is_empty());
assert!(!from_str::<Ascii>("=====").is_empty());
assert!(from_str::<Binary>("=====").is_empty());
}
#[test]
fn test_from_shared_base64_encodes() {
let value = BinaryMetadataValue::try_from(Bytes::from_static(b"Hello")).unwrap();
assert_eq!(value.as_encoded_bytes(), b"SGVsbG8");
}
#[test]
fn test_value_eq_value() {
type BMV = BinaryMetadataValue;
type AMV = AsciiMetadataValue;
assert_eq!(AMV::from_static("abc"), AMV::from_static("abc"));
assert_ne!(AMV::from_static("abc"), AMV::from_static("ABC"));
assert_eq!(BMV::from_bytes(b"abc"), BMV::from_bytes(b"abc"));
assert_ne!(BMV::from_bytes(b"abc"), BMV::from_bytes(b"ABC"));
// Padding is ignored.
assert_eq!(
BMV::from_static("SGVsbG8hIQ=="),
BMV::from_static("SGVsbG8hIQ")
);
// Invalid values are all just invalid from this point of view.
unsafe {
assert_eq!(
BMV::from_shared_unchecked(Bytes::from_static(b"..{}")),
BMV::from_shared_unchecked(Bytes::from_static(b"{}.."))
);
}
}
#[test]
fn test_value_eq_str() {
type BMV = BinaryMetadataValue;
type AMV = AsciiMetadataValue;
assert_eq!(AMV::from_static("abc"), "abc");
assert_ne!(AMV::from_static("abc"), "ABC");
assert_eq!("abc", AMV::from_static("abc"));
assert_ne!("ABC", AMV::from_static("abc"));
assert_eq!(BMV::from_bytes(b"abc"), "abc");
assert_ne!(BMV::from_bytes(b"abc"), "ABC");
assert_eq!("abc", BMV::from_bytes(b"abc"));
assert_ne!("ABC", BMV::from_bytes(b"abc"));
// Padding is ignored.
assert_eq!(BMV::from_static("SGVsbG8hIQ=="), "Hello!!");
assert_eq!("Hello!!", BMV::from_static("SGVsbG8hIQ=="));
}
#[test]
fn test_value_eq_bytes() {
type BMV = BinaryMetadataValue;
type AMV = AsciiMetadataValue;
assert_eq!(AMV::from_static("abc"), "abc".as_bytes());
assert_ne!(AMV::from_static("abc"), "ABC".as_bytes());
assert_eq!(*"abc".as_bytes(), AMV::from_static("abc"));
assert_ne!(*"ABC".as_bytes(), AMV::from_static("abc"));
assert_eq!(*"abc".as_bytes(), BMV::from_bytes(b"abc"));
assert_ne!(*"ABC".as_bytes(), BMV::from_bytes(b"abc"));
// Padding is ignored.
assert_eq!(BMV::from_static("SGVsbG8hIQ=="), "Hello!!".as_bytes());
assert_eq!(*"Hello!!".as_bytes(), BMV::from_static("SGVsbG8hIQ=="));
}
#[test]
fn test_ascii_value_hash() {
use std::collections::hash_map::DefaultHasher;
type AMV = AsciiMetadataValue;
fn hash(value: AMV) -> u64 {
let mut hasher = DefaultHasher::new();
value.hash(&mut hasher);
hasher.finish()
}
let value1 = AMV::from_static("abc");
let value2 = AMV::from_static("abc");
assert_eq!(value1, value2);
assert_eq!(hash(value1), hash(value2));
let value1 = AMV::from_static("abc");
let value2 = AMV::from_static("xyz");
assert_ne!(value1, value2);
assert_ne!(hash(value1), hash(value2));
}
#[test]
fn test_valid_binary_value_hash() {
use std::collections::hash_map::DefaultHasher;
type BMV = BinaryMetadataValue;
fn hash(value: BMV) -> u64 {
let mut hasher = DefaultHasher::new();
value.hash(&mut hasher);
hasher.finish()
}
let value1 = BMV::from_bytes(b"abc");
let value2 = BMV::from_bytes(b"abc");
assert_eq!(value1, value2);
assert_eq!(hash(value1), hash(value2));
let value1 = BMV::from_bytes(b"abc");
let value2 = BMV::from_bytes(b"xyz");
assert_ne!(value1, value2);
assert_ne!(hash(value1), hash(value2));
}
#[test]
fn test_invalid_binary_value_hash() {
use std::collections::hash_map::DefaultHasher;
type BMV = BinaryMetadataValue;
fn hash(value: BMV) -> u64 {
let mut hasher = DefaultHasher::new();
value.hash(&mut hasher);
hasher.finish()
}
unsafe {
let value1 = BMV::from_shared_unchecked(Bytes::from_static(b"..{}"));
let value2 = BMV::from_shared_unchecked(Bytes::from_static(b"{}.."));
assert_eq!(value1, value2);
assert_eq!(hash(value1), hash(value2));
}
unsafe {
let valid = BMV::from_bytes(b"abc");
let invalid = BMV::from_shared_unchecked(Bytes::from_static(b"{}.."));
assert_ne!(valid, invalid);
assert_ne!(hash(valid), hash(invalid));
}
}