Struct MetadataValue 

pub struct MetadataValue { /* private fields */ }

A bounded, recursively typed metadata value.

Constructors preserve ordering and exact text while enforcing limits. The private representation prevents callers from bypassing those invariants.

Implementations

impl MetadataValue

pub fn string(value: impl Into<String>) -> Result<Self>

Creates an unqualified text value.

Errors

Returns ErrorKind::InvalidArgument when the text exceeds its byte limit or contains NUL.

pub fn language_string( value: impl Into<String>, language: impl Into<String>, ) -> Result<Self>

Creates language-tagged text with a syntax-safe BCP 47-shaped tag.

Errors

Returns ErrorKind::InvalidArgument when the text is invalid or the language tag is empty, oversized, or not syntactically safe.

pub const fn i64(value: i64) -> Self

Creates a signed integer value.

pub const fn u64(value: u64) -> Self

Creates an unsigned integer value.

pub const fn decimal(value: DecimalValue) -> Self

Creates an exact decimal value.

pub const fn boolean(value: bool) -> Self

Creates a boolean value.

pub const fn timestamp(value: Timestamp) -> Self

Creates a timestamp value.

pub fn uri(value: impl Into<String>) -> Result<Self>

Creates a URI value while preserving its exact spelling.

Errors

Returns ErrorKind::InvalidArgument when the URI is invalid, oversized, or contains NUL.

pub fn bytes(value: Vec<u8>) -> Result<Self>

Creates an opaque binary value.

Errors

Returns ErrorKind::InvalidArgument when the value exceeds MAX_METADATA_BINARY_BYTES.

pub const fn rational(value: RationalValue) -> Self

Creates an exact rational value.

pub fn list(values: Vec<Self>) -> Result<Self>

Creates an ordered list.

Errors

Returns ErrorKind::InvalidArgument when the item count, aggregate payload size, or nesting depth exceeds its documented limit.

pub fn structure(fields: Vec<MetadataField>) -> Result<Self>

Creates an ordered structured value.

Errors

Returns ErrorKind::InvalidArgument when the field count, aggregate payload size, or nesting depth exceeds its documented limit.

pub const fn reference(value: ObjectRef) -> Self

Creates a reference to another PostProject object.

pub const fn kind(&self) -> MetadataValueKind

Returns the value’s inspectable type.

pub fn as_string(&self) -> Option<&str>

Returns unqualified text, or None for another type.

pub fn as_language_string(&self) -> Option<(&str, &str)>

Returns language-tagged text and its tag, or None for another type.

pub const fn as_i64(&self) -> Option<i64>

Returns a signed integer, or None for another type.

pub const fn as_u64(&self) -> Option<u64>

Returns an unsigned integer, or None for another type.

pub const fn as_decimal(&self) -> Option<DecimalValue>

Returns an exact decimal, or None for another type.

pub const fn as_bool(&self) -> Option<bool>

Returns a boolean, or None for another type.

pub const fn as_timestamp(&self) -> Option<Timestamp>

Returns a timestamp, or None for another type.

pub fn as_uri(&self) -> Option<&str>

Returns URI text, or None for another type.

pub fn as_bytes(&self) -> Option<&[u8]>

Returns opaque bytes, or None for another type.

pub const fn as_rational(&self) -> Option<RationalValue>

Returns an exact rational, or None for another type.

pub fn as_list(&self) -> Option<&[Self]>

Returns ordered list items, or None for another type.

pub fn as_structure(&self) -> Option<&[MetadataField]>

Returns ordered structured fields, or None for another type.

pub const fn as_reference(&self) -> Option<ObjectRef>

Returns an object reference, or None for another type.

pub const fn nesting_depth(&self) -> usize

Returns this value’s nesting depth, including the root value.

pub const fn payload_bytes(&self) -> usize

Returns the bounded aggregate payload size used for validation.

Trait Implementations

impl Clone for MetadataValue

fn clone(&self) -> MetadataValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataValue

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

Formats the value using the given formatter.

impl Eq for MetadataValue

impl Hash for MetadataValue

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MetadataValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MetadataValue