Struct nostr_sdk::nips::nip11::RelayInformationDocument

pub struct RelayInformationDocument {
    pub name: Option<String>,
    pub description: Option<String>,
    pub pubkey: Option<String>,
    pub contact: Option<String>,
    pub supported_nips: Option<Vec<u16, Global>>,
    pub software: Option<String>,
    pub version: Option<String>,
}

Relay information document

Fields

name: Option<String>

Name

description: Option<String>

Description

pubkey: Option<String>

Owner public key

contact: Option<String>

Owner contact

supported_nips: Option<Vec<u16, Global>>

Supported NIPs

software: Option<String>

Software

version: Option<String>

Software version

Implementations

impl RelayInformationDocument

pub fn new() -> RelayInformationDocument

Create new empty RelayInformationDocument

pub async fn get( url: Url, proxy: Option<SocketAddr> ) -> impl Future<Output = Result<RelayInformationDocument, Error>>

Get Relay Information Document

pub fn get_blocking( url: Url, proxy: Option<SocketAddr> ) -> Result<RelayInformationDocument, Error>

Get Relay Information Document

Trait Implementations

impl Clone for RelayInformationDocument

fn clone(&self) -> RelayInformationDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayInformationDocument

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

Formats the value using the given formatter.

impl Default for RelayInformationDocument

fn default() -> RelayInformationDocument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RelayInformationDocument

fn deserialize<__D>( __deserializer: __D ) -> Result<RelayInformationDocument, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RelayInformationDocument

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

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 Ord for RelayInformationDocument

fn cmp(&self, other: &RelayInformationDocument) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<RelayInformationDocument> for RelayInformationDocument

fn eq(&self, other: &RelayInformationDocument) -> 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 PartialOrd<RelayInformationDocument> for RelayInformationDocument

fn partial_cmp(&self, other: &RelayInformationDocument) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RelayInformationDocument

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 RelayInformationDocument

impl StructuralEq for RelayInformationDocument

impl StructuralPartialEq for RelayInformationDocument