Struct Metadata 

#[non_exhaustive]
pub struct Metadata {
    pub title: Option<String>,
    pub author: Option<String>,
    pub subject: Option<String>,
    pub description: Option<String>,
    pub last_saved_by: Option<String>,
    pub keywords: Vec<String>,
    pub created: Option<String>,
    pub modified: Option<String>,
    pub extras: BTreeMap<String, String>,
}

Document metadata: title, author, subject, keywords, timestamps.

All fields are optional. Default returns a fully empty metadata (all None / empty Vec / empty map).

Design Decisions

Timestamps use Option<String> (ISO 8601) instead of chrono::DateTime. Rationale: chrono adds ~250KB compile weight for two fields that Core never does arithmetic on. Smithy crates parse and validate dates when reading from format-specific sources.

#[non_exhaustive] mirrors the established Core pattern (Control, shape enums, etc.). New fields can be added in future versions without breaking external struct literals — callers must use ..Default::default(). See CLAUDE.md “semver-first” working principle.

extras carries <opf:meta name="X"> entries (HWPX) or PropertySet entries (HWP5) that have not yet been promoted to typed fields. Uses BTreeMap for deterministic ordering so encoder output is byte-stable for round-trip tests. Keys are the wire name= value (e.g. "category"); values are the raw text content.

Examples

use hwpforge_core::Metadata;

let meta = Metadata::default();
assert!(meta.title.is_none());
assert!(meta.keywords.is_empty());
assert!(meta.extras.is_empty());

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

title: Option<String>

Document title.

author: Option<String>

Document author (corresponds to HWPX <opf:meta name="creator">).

subject: Option<String>

Document subject (corresponds to HWPX <opf:meta name="subject">).

description: Option<String>

Free-form description (corresponds to HWPX <opf:meta name="description">).

Distinct from subject: subject is the canonical “subject” line; description carries longer prose summary text that Hancom stores separately.

last_saved_by: Option<String>

Last person to save the document (corresponds to HWPX <opf:meta name="lastsaveby">).

Distinct from author: author is the document creator; last_saved_by is the most recent editor. Hancom surfaces this via the $lastsaveby SUMMERY auto-field.

keywords: Vec<String>

Searchable keywords.

Encoders that target HWPX join with ";" into a single <opf:meta name="keyword"> element (matches Hancom convention).

created: Option<String>

Creation timestamp in ISO 8601 format (e.g. "2026-02-07T10:30:00Z").

modified: Option<String>

Last modification timestamp in ISO 8601 format.

extras: BTreeMap<String, String>

Carry slot for <opf:meta> keys not yet promoted to typed fields. Preserves lossless round-trip when Hancom adds new metadata names that HwpForge has not modeled yet.

Implementations

impl Metadata

pub fn new() -> Self

Returns a fresh Metadata with all fields at their default (None / empty). Equivalent to Metadata::default(); provided as a chainable seed for builder-style construction so external crates can populate the #[non_exhaustive] struct without struct-literal syntax.

pub fn with_title(self, value: impl Into<String>) -> Self

Sets the document title.

pub fn with_author(self, value: impl Into<String>) -> Self

Sets the document author.

pub fn with_subject(self, value: impl Into<String>) -> Self

Sets the document subject.

pub fn with_description(self, value: impl Into<String>) -> Self

Sets the document description.

pub fn with_last_saved_by(self, value: impl Into<String>) -> Self

Sets the document last_saved_by.

pub fn with_keywords<I, S>(self, values: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the document keywords list.

pub fn with_created(self, value: impl Into<String>) -> Self

Sets the created timestamp (ISO 8601).

pub fn with_modified(self, value: impl Into<String>) -> Self

Sets the modified timestamp (ISO 8601).

pub fn with_extra( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Inserts a single <opf:meta> carry entry into extras. Chainable.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Metadata

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

Formats the value using the given formatter.

impl Eq for Metadata

impl JsonSchema for Metadata

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Metadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Metadata