Struct nostr_sdk::Filter

pub struct Filter {
    pub ids: Option<Vec<String, Global>>,
    pub authors: Option<Vec<String, Global>>,
    pub kinds: Option<Vec<Kind, Global>>,
    pub events: Option<Vec<EventId, Global>>,
    pub pubkeys: Option<Vec<XOnlyPublicKey, Global>>,
    pub hashtags: Option<Vec<String, Global>>,
    pub references: Option<Vec<String, Global>>,
    pub search: Option<String>,
    pub since: Option<Timestamp>,
    pub until: Option<Timestamp>,
    pub limit: Option<usize>,
    pub custom: Map<String, Value>,
}

Subscription filters

Fields

ids: Option<Vec<String, Global>>

List of event ids or prefixes

authors: Option<Vec<String, Global>>

List of pubkeys or prefixes

kinds: Option<Vec<Kind, Global>>

List of a kind numbers

events: Option<Vec<EventId, Global>>

#e tag

pubkeys: Option<Vec<XOnlyPublicKey, Global>>

#p tag

hashtags: Option<Vec<String, Global>>

#t tag

references: Option<Vec<String, Global>>

#r 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

custom: Map<String, Value>

Custom fields

Implementations

impl Filter

pub fn new() -> Filter

Create new empty Filter

pub fn from_json<S>(json: S) -> Result<Filter, 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) -> Filterwhere S: Into<String>,

Set event id or prefix

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

Set event ids or prefixes

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

Set author

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

Set authors

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

Set kind

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

Set kinds

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

Set event

pub fn events(self, ids: Vec<EventId, Global>) -> Filter

Set events

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

Set pubkey

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

Set pubkeys

pub fn hashtag(self, hashtag: impl Into<String>) -> Filter

Set hashtag

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

pub fn hashtags(self, hashtags: impl Into<Vec<String, Global>>) -> Filter

Set hashtags

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

pub fn reference(self, v: impl Into<String>) -> Filter

Set reference

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

pub fn references(self, v: impl Into<Vec<String, Global>>) -> Filter

Set references

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

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

Set search field

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

Set since unix timestamp

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

Set until unix timestamp

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

Set limit

pub fn custom(self, map: Map<String, Value>) -> Filter

Set custom filters

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

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<Filter, <D as Deserializer<'de>>::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 as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Filter

impl StructuralEq for Filter

impl StructuralPartialEq for Filter