Struct tonic::metadata::MetadataValue
source · pub struct MetadataValue<VE: ValueEncoding> { /* private fields */ }
Expand description
Represents a custom metadata field value.
MetadataValue
is used as the MetadataMap
value.
Implementations§
source§impl<VE: ValueEncoding> MetadataValue<VE>
impl<VE: ValueEncoding> MetadataValue<VE>
sourcepub fn from_static(src: &'static str) -> Self
pub fn from_static(src: &'static str) -> Self
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
let val = AsciiMetadataValue::from_static("hello");
assert_eq!(val, "hello");
let val = BinaryMetadataValue::from_static("SGVsbG8hIQ==");
assert_eq!(val, "Hello!!");
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.
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true if the MetadataValue
has a length of zero bytes.
§Examples
let val = AsciiMetadataValue::from_static("");
assert!(val.is_empty());
let val = AsciiMetadataValue::from_static("hello");
assert!(!val.is_empty());
sourcepub fn to_bytes(&self) -> Result<Bytes, InvalidMetadataValueBytes>
pub fn to_bytes(&self) -> Result<Bytes, InvalidMetadataValueBytes>
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
let val = AsciiMetadataValue::from_static("hello");
assert_eq!(val.to_bytes().unwrap().as_ref(), b"hello");
let val = BinaryMetadataValue::from_bytes(b"hello");
assert_eq!(val.to_bytes().unwrap().as_ref(), b"hello");
sourcepub fn set_sensitive(&mut self, val: bool)
pub fn set_sensitive(&mut self, val: bool)
Mark that the metadata value represents sensitive information.
§Examples
let mut val = AsciiMetadataValue::from_static("my secret");
val.set_sensitive(true);
assert!(val.is_sensitive());
val.set_sensitive(false);
assert!(!val.is_sensitive());
sourcepub fn is_sensitive(&self) -> bool
pub fn is_sensitive(&self) -> bool
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
let mut val = AsciiMetadataValue::from_static("my secret");
val.set_sensitive(true);
assert!(val.is_sensitive());
val.set_sensitive(false);
assert!(!val.is_sensitive());
sourcepub fn as_encoded_bytes(&self) -> &[u8] ⓘ
pub fn as_encoded_bytes(&self) -> &[u8] ⓘ
Converts a MetadataValue
to a byte slice. For Binary values, the
return value is base64 encoded.
§Examples
let val = AsciiMetadataValue::from_static("hello");
assert_eq!(val.as_encoded_bytes(), b"hello");
let val = BinaryMetadataValue::from_bytes(b"Hello!");
assert_eq!(val.as_encoded_bytes(), b"SGVsbG8h");
source§impl MetadataValue<Ascii>
impl MetadataValue<Ascii>
sourcepub fn from_key<KeyVE: ValueEncoding>(key: MetadataKey<KeyVE>) -> Self
pub fn from_key<KeyVE: ValueEncoding>(key: MetadataKey<KeyVE>) -> Self
Converts a MetadataKey into a MetadataValue<Ascii>
.
Since every valid MetadataKey is a valid MetadataValue this is done infallibly.
§Examples
let val = AsciiMetadataValue::from_key::<Ascii>("accept".parse().unwrap());
assert_eq!(val, AsciiMetadataValue::try_from(b"accept").unwrap());
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
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
let val = AsciiMetadataValue::from_static("hello");
assert_eq!(val.len(), 5);
sourcepub fn to_str(&self) -> Result<&str, ToStrError>
pub fn to_str(&self) -> Result<&str, ToStrError>
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
let val = AsciiMetadataValue::from_static("hello");
assert_eq!(val.to_str().unwrap(), "hello");
source§impl MetadataValue<Binary>
impl MetadataValue<Binary>
sourcepub fn from_bytes(src: &[u8]) -> Self
pub fn from_bytes(src: &[u8]) -> Self
Convert a byte slice to a MetadataValue<Binary>
.
§Examples
let val = BinaryMetadataValue::from_bytes(b"hello\xfa");
assert_eq!(val, &b"hello\xfa"[..]);
Trait Implementations§
source§impl<VE: ValueEncoding> AsRef<[u8]> for MetadataValue<VE>
impl<VE: ValueEncoding> AsRef<[u8]> for MetadataValue<VE>
source§impl<VE: Clone + ValueEncoding> Clone for MetadataValue<VE>
impl<VE: Clone + ValueEncoding> Clone for MetadataValue<VE>
source§fn clone(&self) -> MetadataValue<VE>
fn clone(&self) -> MetadataValue<VE>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<VE: ValueEncoding> Debug for MetadataValue<VE>
impl<VE: ValueEncoding> Debug for MetadataValue<VE>
source§impl<'a, VE: ValueEncoding> From<&'a MetadataValue<VE>> for MetadataValue<VE>
impl<'a, VE: ValueEncoding> From<&'a MetadataValue<VE>> for MetadataValue<VE>
source§fn from(t: &'a MetadataValue<VE>) -> Self
fn from(t: &'a MetadataValue<VE>) -> Self
source§impl<KeyVE: ValueEncoding> From<MetadataKey<KeyVE>> for MetadataValue<Ascii>
impl<KeyVE: ValueEncoding> From<MetadataKey<KeyVE>> for MetadataValue<Ascii>
source§fn from(h: MetadataKey<KeyVE>) -> MetadataValue<Ascii>
fn from(h: MetadataKey<KeyVE>) -> MetadataValue<Ascii>
source§impl<VE: ValueEncoding> From<MetadataValue<VE>> for Bytes
impl<VE: ValueEncoding> From<MetadataValue<VE>> for Bytes
source§fn from(value: MetadataValue<VE>) -> Bytes
fn from(value: MetadataValue<VE>) -> Bytes
source§impl FromStr for MetadataValue<Ascii>
impl FromStr for MetadataValue<Ascii>
source§impl Hash for MetadataValue<Ascii>
impl Hash for MetadataValue<Ascii>
source§impl Hash for MetadataValue<Binary>
impl Hash for MetadataValue<Binary>
source§impl<VE: ValueEncoding> Ord for MetadataValue<VE>
impl<VE: ValueEncoding> Ord for MetadataValue<VE>
source§impl<'a, VE: ValueEncoding, T: ?Sized> PartialEq<&'a T> for MetadataValue<VE>where
MetadataValue<VE>: PartialEq<T>,
impl<'a, VE: ValueEncoding, T: ?Sized> PartialEq<&'a T> for MetadataValue<VE>where
MetadataValue<VE>: PartialEq<T>,
source§impl<VE: ValueEncoding> PartialEq<[u8]> for MetadataValue<VE>
impl<VE: ValueEncoding> PartialEq<[u8]> for MetadataValue<VE>
source§impl<'a, VE: ValueEncoding> PartialEq<MetadataValue<VE>> for &'a MetadataValue<VE>
impl<'a, VE: ValueEncoding> PartialEq<MetadataValue<VE>> for &'a MetadataValue<VE>
source§impl<'a, VE: ValueEncoding> PartialEq<MetadataValue<VE>> for &'a str
impl<'a, VE: ValueEncoding> PartialEq<MetadataValue<VE>> for &'a str
source§impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for [u8]
impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for [u8]
source§impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for String
impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for String
source§impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for str
impl<VE: ValueEncoding> PartialEq<MetadataValue<VE>> for str
source§impl<VE: ValueEncoding> PartialEq<String> for MetadataValue<VE>
impl<VE: ValueEncoding> PartialEq<String> for MetadataValue<VE>
source§impl<VE: ValueEncoding> PartialEq<str> for MetadataValue<VE>
impl<VE: ValueEncoding> PartialEq<str> for MetadataValue<VE>
source§impl<VE: ValueEncoding> PartialEq for MetadataValue<VE>
impl<VE: ValueEncoding> PartialEq for MetadataValue<VE>
source§impl<'a, VE: ValueEncoding, T: ?Sized> PartialOrd<&'a T> for MetadataValue<VE>where
MetadataValue<VE>: PartialOrd<T>,
impl<'a, VE: ValueEncoding, T: ?Sized> PartialOrd<&'a T> for MetadataValue<VE>where
MetadataValue<VE>: PartialOrd<T>,
source§impl<VE: ValueEncoding> PartialOrd<[u8]> for MetadataValue<VE>
impl<VE: ValueEncoding> PartialOrd<[u8]> for MetadataValue<VE>
source§impl<'a, VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for &'a MetadataValue<VE>
impl<'a, VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for &'a MetadataValue<VE>
source§impl<'a, VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for &'a str
impl<'a, VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for &'a str
source§impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for [u8]
impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for [u8]
source§impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for String
impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for String
source§impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for str
impl<VE: ValueEncoding> PartialOrd<MetadataValue<VE>> for str
source§impl<VE: ValueEncoding> PartialOrd<String> for MetadataValue<VE>
impl<VE: ValueEncoding> PartialOrd<String> for MetadataValue<VE>
source§impl<VE: ValueEncoding> PartialOrd<str> for MetadataValue<VE>
impl<VE: ValueEncoding> PartialOrd<str> for MetadataValue<VE>
source§impl<VE: ValueEncoding> PartialOrd for MetadataValue<VE>
impl<VE: ValueEncoding> PartialOrd for MetadataValue<VE>
source§impl<'a, VE: ValueEncoding> TryFrom<&'a [u8]> for MetadataValue<VE>
impl<'a, VE: ValueEncoding> TryFrom<&'a [u8]> for MetadataValue<VE>
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
let val = AsciiMetadataValue::try_from(b"hello\xfa").unwrap();
assert_eq!(val, &b"hello\xfa"[..]);
An invalid value
let val = AsciiMetadataValue::try_from(b"\n");
assert!(val.is_err());
source§impl<'a, VE: ValueEncoding, const N: usize> TryFrom<&'a [u8; N]> for MetadataValue<VE>
impl<'a, VE: ValueEncoding, const N: usize> TryFrom<&'a [u8; N]> for MetadataValue<VE>
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
let val = AsciiMetadataValue::try_from(b"hello\xfa").unwrap();
assert_eq!(val, &b"hello\xfa"[..]);
An invalid value
let val = AsciiMetadataValue::try_from(b"\n");
assert!(val.is_err());
source§impl<'a> TryFrom<&'a String> for MetadataValue<Ascii>
impl<'a> TryFrom<&'a String> for MetadataValue<Ascii>
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).
source§impl<'a> TryFrom<&'a str> for MetadataValue<Ascii>
impl<'a> TryFrom<&'a str> for MetadataValue<Ascii>
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).
source§impl<VE: ValueEncoding> TryFrom<Bytes> for MetadataValue<VE>
impl<VE: ValueEncoding> TryFrom<Bytes> for MetadataValue<VE>
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.
source§impl TryFrom<String> for MetadataValue<Ascii>
impl TryFrom<String> for MetadataValue<Ascii>
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).
source§impl<VE: ValueEncoding> TryFrom<Vec<u8>> for MetadataValue<VE>
impl<VE: ValueEncoding> TryFrom<Vec<u8>> for MetadataValue<VE>
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> Eq for MetadataValue<VE>
Auto Trait Implementations§
impl<VE> !Freeze for MetadataValue<VE>
impl<VE> RefUnwindSafe for MetadataValue<VE>where
VE: RefUnwindSafe,
impl<VE> Send for MetadataValue<VE>where
VE: Send,
impl<VE> Sync for MetadataValue<VE>where
VE: Sync,
impl<VE> Unpin for MetadataValue<VE>where
VE: Unpin,
impl<VE> UnwindSafe for MetadataValue<VE>where
VE: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request