Struct UserMetadata 

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

An ordered string-to-string metadata map with safe structural formatting.

Examples

use qubit_fs::metadata::UserMetadata;

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

Implementations

impl UserMetadata

pub const fn new() -> Self

Creates empty metadata.

pub fn with(self, key: &str, value: &str) -> Result<Self, FsError>

Adds one metadata pair.

Errors

Returns an invalid-options error when the key resembles credential material.

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

Returns the value associated with a key.

pub fn is_empty(&self) -> bool

Returns whether the map contains no metadata pairs.

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

Returns whether a metadata key is present.

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Returns an iterator over metadata pairs.

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 UserMetadata

fn clone(&self) -> UserMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserMetadata

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl Default for UserMetadata

fn default() -> UserMetadata

Returns the “default value” for a type.

impl Eq for UserMetadata

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 UserMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UserMetadata