Struct nostr_sdk::Metadata

pub struct Metadata {
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub about: Option<String>,
    pub website: Option<String>,
    pub picture: Option<String>,
    pub banner: Option<String>,
    pub nip05: Option<String>,
    pub lud06: Option<String>,
    pub lud16: Option<String>,
    pub custom: BTreeMap<String, Value, Global>,
}

Metadata

Fields

name: Option<String>

Name

display_name: Option<String>

Display name

about: Option<String>

Description

website: Option<String>

Website url

picture: Option<String>

Picture url

banner: Option<String>

Banner url

nip05: Option<String>

NIP05 (ex. name@example.com)

lud06: Option<String>

LNURL

lud16: Option<String>

Lightning Address

custom: BTreeMap<String, Value, Global>

Custom fields

Implementations

impl Metadata

pub fn new() -> Metadata

New empty Metadata

pub fn from_json<S>(json: S) -> Result<Metadata, Error>where S: Into<String>,

Deserialize Metadata from JSON string

pub fn as_json(&self) -> String

Serialize Metadata to JSON string

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

Set name

pub fn display_name<S>(self, display_name: S) -> Metadatawhere S: Into<String>,

Set display_name

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

Set about

pub fn website(self, url: Url) -> Metadata

Set website

pub fn picture(self, url: Url) -> Metadata

Set picture

pub fn banner(self, url: Url) -> Metadata

Set banner

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

Set nip05

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

Set lud06 (LNURL)

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

Set lud16 (Lightning Address)

pub fn custom_field<S>(self, field_name: S, value: Value) -> Metadatawhere S: Into<String>,

Set custom metadata field

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy 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<(), Error>

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<Metadata, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Metadata> for Metadata

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Metadata

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

Serialize this value into the given Serde serializer.

impl Eq for Metadata

impl StructuralEq for Metadata

impl StructuralPartialEq for Metadata