Struct nostr::message::subscription::Filter

pub struct Filter {

    pub ids: Vec<String>,
    pub authors: Vec<String>,
    pub kinds: Vec<Kind>,
    pub events: Vec<EventId>,
    pub pubkeys: Vec<XOnlyPublicKey>,
    pub hashtags: Vec<String>,
    pub references: Vec<String>,
    pub identifiers: Vec<String>,
    pub search: Option<String>,
    pub since: Option<Timestamp>,
    pub until: Option<Timestamp>,
    pub limit: Option<usize>,
    pub generic_tags: HashMap<Alphabet, Vec<String>>,
}

Subscription filters

Fields

ids: Vec<String>

List of event ids or prefixes

authors: Vec<String>

List of pubkeys or prefixes

kinds: Vec<Kind>

List of a kind numbers

events: Vec<EventId>

#e tag

pubkeys: Vec<XOnlyPublicKey>

#p tag

hashtags: Vec<String>

#t tag

references: Vec<String>

#r tag

identifiers: Vec<String>

#d tag

search: Option<String>

It’s a string describing a query in a human-readable form, i.e. “best nostr apps”

https://github.com/nostr-protocol/nips/blob/master/50.md

since: Option<Timestamp>

An integer unix timestamp, events must be newer than this to pass

until: Option<Timestamp>

An integer unix timestamp, events must be older than this to pass

limit: Option<usize>

Maximum number of events to be returned in the initial query

generic_tags: HashMap<Alphabet, Vec<String>>

Generic tag queries (NIP12)

Implementations

impl Filter

pub fn new() -> Self

Create new empty Filter

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

Deserialize from JSON string

pub fn as_json(&self) -> String

Serialize to JSON string

pub fn id<S>(self, id: S) -> Selfwhere S: Into<String>,

Add event id or prefix

pub fn ids<S>(self, ids: Vec<S>) -> Selfwhere S: Into<String>,

Add event ids or prefixes

pub fn remove_ids<S>(self, ids: Vec<S>) -> Selfwhere S: Into<String>,

Remove event ids or prefixes

pub fn author<S>(self, author: S) -> Selfwhere S: Into<String>,

Add author

pub fn authors<S>(self, authors: Vec<S>) -> Selfwhere S: Into<String>,

Add authors

pub fn remove_authors<S>(self, authors: Vec<S>) -> Selfwhere S: Into<String>,

Remove authors

pub fn kind(self, kind: Kind) -> Self

Add kind

pub fn kinds(self, kinds: Vec<Kind>) -> Self

Add kinds

pub fn remove_kinds(self, kinds: Vec<Kind>) -> Self

Remove kinds

pub fn event(self, id: EventId) -> Self

Add event

pub fn events(self, events: Vec<EventId>) -> Self

Add events

pub fn remove_events<S>(self, events: Vec<EventId>) -> Self

Remove events

pub fn pubkey(self, pubkey: XOnlyPublicKey) -> Self

Add pubkey

pub fn pubkeys(self, pubkeys: Vec<XOnlyPublicKey>) -> Self

Add pubkeys

pub fn remove_pubkeys<S>(self, pubkeys: Vec<XOnlyPublicKey>) -> Self

Remove pubkeys

pub fn hashtag<S>(self, hashtag: S) -> Selfwhere S: Into<String>,

Add hashtag

https://github.com/nostr-protocol/nips/blob/master/12.md

pub fn hashtags<S>(self, hashtags: Vec<S>) -> Selfwhere S: Into<String>,

Add hashtags

https://github.com/nostr-protocol/nips/blob/master/12.md

pub fn remove_hashtags<S>(self, hashtags: Vec<S>) -> Selfwhere S: Into<String>,

Remove hashtags

pub fn reference<S>(self, reference: S) -> Selfwhere S: Into<String>,

Add reference

https://github.com/nostr-protocol/nips/blob/master/12.md

pub fn references<S>(self, references: Vec<S>) -> Selfwhere S: Into<String>,

Add references

https://github.com/nostr-protocol/nips/blob/master/12.md

pub fn remove_references<S>(self, references: Vec<S>) -> Selfwhere S: Into<String>,

Remove references

pub fn identifier<S>(self, identifier: S) -> Selfwhere S: Into<String>,

Add identifier

https://github.com/nostr-protocol/nips/blob/master/33.md

pub fn identifiers<S>(self, identifiers: Vec<S>) -> Selfwhere S: Into<String>,

Add identifiers

https://github.com/nostr-protocol/nips/blob/master/33.md

pub fn remove_identifiers<S>(self, identifiers: Vec<S>) -> Selfwhere S: Into<String>,

Remove identifiers

pub fn search<S>(self, value: S) -> Selfwhere S: Into<String>,

Add search field

pub fn remove_search(self) -> Self

Remove search

pub fn since(self, since: Timestamp) -> Self

Add since unix timestamp

pub fn remove_since(self) -> Self

Remove since

pub fn until(self, until: Timestamp) -> Self

Add until unix timestamp

pub fn remove_until(self) -> Self

Remove until

pub fn limit(self, limit: usize) -> Self

Add limit

pub fn remove_limit(self) -> Self

Remove limit

pub fn custom_tag<S>(self, tag: Alphabet, values: Vec<S>) -> Selfwhere S: Into<String>,

Add custom tag

pub fn remove_custom_tag<S>(self, tag: Alphabet, values: Vec<S>) -> Selfwhere S: Into<String>,

Remove identifiers

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Default for Filter

fn default() -> Filter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Filter

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Filter> for Filter

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

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

Serialize this value into the given Serde serializer.

impl Eq for Filter

impl StructuralEq for Filter

impl StructuralPartialEq for Filter