Struct Metadata 

pub struct Metadata {
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub about: Option<String>,
    pub website: Option<Url>,
    pub picture: Option<Url>,
    pub banner: Option<Url>,
    pub nip05: Option<String>,
    pub lud06: Option<String>,
    pub lud16: Option<String>,
    pub bot: Option<bool>,
    pub birthday: Option<Birthday>,
    pub custom: Map<String, Value>,
}

User profile metadata published as the content of a kind: 0 event.

Every field is optional; unknown JSON properties survive a round-trip via Metadata::custom.

Fields

name: Option<String>

Short username, e.g. alice.

display_name: Option<String>

Display name (NIP-24).

about: Option<String>

Biographical description.

website: Option<Url>

Personal web site (NIP-24).

picture: Option<Url>

Profile picture URL.

banner: Option<Url>

Banner image URL (NIP-24).

nip05: Option<String>

NIP-05 verification identifier (alice@example.com).

lud06: Option<String>

LNURL-pay identifier (legacy LUD-06).

lud16: Option<String>

Lightning Address (LUD-16).

bot: Option<bool>

NIP-24 bot flag: true if the profile is fully or partially automated (chatbots, newsfeeds, AI agents).

birthday: Option<Birthday>

NIP-24 birthday object. Every component (year / month / day) is individually optional so partial dates (e.g. month-and-day only) round-trip cleanly.

custom: Map<String, Value>

Forward-compatible escape hatch: any property the spec adds (or any project-specific custom property) is preserved verbatim here.

Two NIP-24 deprecated fields intentionally land here rather than in dedicated fields:

• displayName (camel-case) — superseded by Self::display_name;
• username — superseded by Self::name.

Access them via Self::legacy_display_name and Self::legacy_username when a caller needs to migrate an old profile without dropping bytes.

Implementations

impl Metadata

pub fn new() -> Self

Construct an empty profile.

pub fn with_name<S: Into<String>>(self, name: S) -> Self

Set the name field.

pub fn with_display_name<S: Into<String>>(self, name: S) -> Self

Set the display_name field (NIP-24).

pub fn with_about<S: Into<String>>(self, about: S) -> Self

Set the about field.

pub fn with_website(self, website: Url) -> Self

Set the website field.

pub fn with_picture(self, picture: Url) -> Self

Set the picture field.

pub fn with_banner(self, banner: Url) -> Self

Set the banner field (NIP-24).

pub fn with_nip05<S: Into<String>>(self, nip05: S) -> Self

Set the nip05 field.

pub fn with_lud06<S: Into<String>>(self, lud06: S) -> Self

Set the lud06 field (legacy LNURL-pay).

pub fn with_lud16<S: Into<String>>(self, lud16: S) -> Self

Set the lud16 field (Lightning Address).

pub const fn with_bot(self, bot: bool) -> Self

Set the NIP-24 bot flag.

pub const fn with_birthday(self, birthday: Birthday) -> Self

Set the NIP-24 birthday object.

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

Return the deprecated NIP-24 displayName value if the profile was produced by an older client. Prefer Self::display_name for every new write path.

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

Return the deprecated NIP-24 username value. Prefer Self::name for every new write path.

pub fn with_custom<S, V>(self, key: S, value: V) -> Self

where S: Into<String>, V: Into<JsonValue>,

Insert a custom JSON property.

Useful for extensions defined by future NIPs that this crate has not modelled yet.

pub fn to_event_content(&self) -> Result<String, Error>

Render self as the JSON string that goes into a kind: 0 event’s content field.

Errors

Returns the underlying serde_json error if the metadata cannot be serialized (in practice impossible for user metadata, but serde_json keeps the type fallible).

pub fn from_event_content(content: &str) -> Result<Self, Error>

Parse the content of a kind: 0 event into a Metadata.

Errors

Returns a serde_json error if content is not a JSON object.

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 Eq for Metadata

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