Struct NonSensitiveMetadata 

pub struct NonSensitiveMetadata(/* private fields */);

Flat metadata whose keys have passed credential-sensitivity checks.

UserMetadata stores ordered string pairs and rejects credential-like keys when each pair is added. This type’s Debug implementation prints keys only and never automatically exposes values.

The inner UserMetadata is not mutably exposed, so every value of this type retains the wrapper invariant after construction.

Examples

use qubit_fs::metadata::{NonSensitiveMetadata, UserMetadata};

let safe = NonSensitiveMetadata::from(
    UserMetadata::new().with("content-language", "en")?,
);
assert_eq!(Some("en"), safe.get("content-language"));

Implementations

impl NonSensitiveMetadata

pub fn new() -> Self

Creates empty validated metadata.

pub const fn as_metadata(&self) -> &UserMetadata

Returns the validated metadata without mutable access.

pub fn into_metadata(self) -> UserMetadata

Consumes this wrapper and returns the underlying metadata.

pub fn is_empty(&self) -> bool

Returns whether the wrapped map contains no metadata pairs.

pub fn contains_key(&self, key: &str) -> bool

Returns whether a metadata key is present.

pub fn get(&self, key: &str) -> Option<&str>

Returns the value associated with a metadata key.

Returns

Some with the value when key is present, or None otherwise.

Trait Implementations

impl AsRef<UserMetadata> for NonSensitiveMetadata

fn as_ref(&self) -> &UserMetadata

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NonSensitiveMetadata

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NonSensitiveMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NonSensitiveMetadata

fn default() -> Self

Returns the “default value” for a type.

impl From<NonSensitiveMetadata> for UserMetadata

fn from(metadata: NonSensitiveMetadata) -> Self

Converts to this type from the input type.

impl From<UserMetadata> for NonSensitiveMetadata

fn from(metadata: UserMetadata) -> Self

Wraps arbitrary user metadata.

impl PartialEq for NonSensitiveMetadata

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NonSensitiveMetadata