Struct ChannelMetadata 

pub struct ChannelMetadata {
    pub name: Option<String>,
    pub about: Option<String>,
    pub picture: Option<String>,
    pub relays: Vec<RelayUrl>,
    pub extra: IndexMap<String, Value>,
}

JSON .content body for kinds 40 and 41.

The four spec-named fields (name, about, picture, relays) are first-class. Any other JSON property the originating app stamps on the metadata object survives via Self::extra.

Fields

name: Option<String>

Channel name (kind 40 / 41 §“name”).

about: Option<String>

Long-form description (kind 40 / 41 §“about”).

picture: Option<String>

URL of channel picture. Spec leaves the value unconstrained so we keep it as String; callers that need URL validation should round-trip through crate::Url themselves.

relays: Vec<RelayUrl>

Relays where the channel events are broadcast.

extra: IndexMap<String, Value>

Forward-compatible passthrough of every other JSON property.

Implementations

impl ChannelMetadata

pub fn new() -> Self

Construct an empty bundle.

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

Set Self::name.

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

Set Self::about.

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

Set Self::picture.

pub fn relay(self, relay: RelayUrl) -> Self

Append a relay hint.

pub fn relays<I>(self, relays: I) -> Self

where I: IntoIterator<Item = RelayUrl>,

Append several relay hints.

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

Render to JSON ready for use as .content.

Errors

Forwarded from serde_json — the only failure modes are non-UTF-8 strings inside Self::extra, which Rust strings cannot represent in the first place, or numeric overflow in callers that put serde_json::Number::from_f64(f64::NAN) in extra. Both are degenerate.

pub fn from_json(json: &str) -> Result<Self, ChannelMetadataError>

Parse a JSON .content string into the typed bundle.

Errors

• ChannelMetadataError::InvalidJson when the input is not a JSON object.
• ChannelMetadataError::InvalidRelayUrl when a relays[i] string fails RelayUrl::parse.

Trait Implementations

impl Clone for ChannelMetadata

fn clone(&self) -> ChannelMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelMetadata

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

Formats the value using the given formatter.

impl Default for ChannelMetadata

fn default() -> ChannelMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChannelMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ChannelMetadata

impl PartialEq for ChannelMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChannelMetadata

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 ChannelMetadata