Struct Filter 

pub struct Filter {
    pub ids: Option<BTreeSet<EventId>>,
    pub authors: Option<BTreeSet<PublicKey>>,
    pub kinds: Option<BTreeSet<Kind>>,
    pub search: Option<String>,
    pub since: Option<Timestamp>,
    pub until: Option<Timestamp>,
    pub limit: Option<usize>,
    pub generic_tags: BTreeMap<SingleLetterTag, BTreeSet<String>>,
}

Subscription filters

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

Fields

ids: Option<BTreeSet<EventId>>

List of EventId

authors: Option<BTreeSet<PublicKey>>

List of PublicKey

kinds: Option<BTreeSet<Kind>>

List of a kind numbers

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: BTreeMap<SingleLetterTag, BTreeSet<String>>

Generic tag queries

Implementations

impl Filter

pub fn new() -> Self

Create new empty Filter

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

Add EventId

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

where I: IntoIterator<Item = EventId>,

Add event ids or prefixes

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

where I: IntoIterator<Item = EventId>,

Remove event ids

pub fn author(self, author: PublicKey) -> Self

Add author

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

where I: IntoIterator<Item = PublicKey>,

Add authors

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

where I: IntoIterator<Item = PublicKey>,

Remove authors

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

Add kind

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

where I: IntoIterator<Item = Kind>,

Add kinds

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

where I: IntoIterator<Item = Kind>,

Remove kinds

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

Add event

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

where I: IntoIterator<Item = EventId>,

Add events

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

where I: IntoIterator<Item = EventId>,

Remove events

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

Add pubkey

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

where I: IntoIterator<Item = PublicKey>,

Add pubkeys

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

where I: IntoIterator<Item = PublicKey>,

Remove pubkeys

pub fn hashtag<S>(self, hashtag: S) -> Self

where S: Into<String>,

Add hashtag

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

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

where I: IntoIterator<Item = S>, S: Into<String>,

Add hashtags

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

pub fn remove_hashtags<I, S>(self, hashtags: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Remove hashtags

pub fn reference<S>(self, reference: S) -> Self

where S: Into<String>,

Add reference

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

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

where I: IntoIterator<Item = S>, S: Into<String>,

Add references

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

pub fn remove_references<I, S>(self, references: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Remove references

pub fn identifier<S>(self, identifier: S) -> Self

where S: Into<String>,

Add identifier

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

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

where I: IntoIterator<Item = S>, S: Into<String>,

Add identifiers

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

pub fn remove_identifiers<I, S>(self, identifiers: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Remove identifiers

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

pub fn coordinate(self, coordinate: &Coordinate) -> Self

Add coordinate

Query for a tag.

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

pub fn coordinates<'a, I>(self, coordinates: I) -> Self

where I: IntoIterator<Item = &'a Coordinate>,

Add coordinates

Query for a tags.

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

pub fn remove_coordinates<'a, I>(self, coordinates: I) -> Self

where I: IntoIterator<Item = &'a Coordinate>,

Remove coordinates

Remove a tags.

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

pub fn search<S>(self, value: S) -> Self

where 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

Maximum number of events to be returned in the initial query

pub fn remove_limit(self) -> Self

Remove limit

pub fn custom_tag<S>(self, tag: SingleLetterTag, value: S) -> Self

where S: Into<String>,

Add custom tag

pub fn custom_tags<I, S>(self, tag: SingleLetterTag, values: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add custom tags

pub fn remove_custom_tags<I, T>(self, tag: SingleLetterTag, values: I) -> Self

where I: IntoIterator<Item = T>, T: Into<String>,

Remove custom tag

pub fn is_empty(&self) -> bool

Check if Filter is empty

pub fn extract_public_keys(&self) -> BTreeSet<PublicKey>

Extract all public keys (both from authors and #p)

pub fn match_event(&self, event: &Event, opts: MatchEventOptions) -> bool

Determine if Filter match given Event.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a duplicate 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 From<&Coordinate> for Filter

fn from(value: &Coordinate) -> Self

Converts to this type from the input type.

impl From<Coordinate> for Filter

fn from(value: Coordinate) -> Self

Converts to this type from the input type.

impl From<Filter> for Vec<Filter>

fn from(filter: Filter) -> Self

Converts to this type from the input type.

impl Hash for Filter

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

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 JsonUtil for Filter

type Err = Error

Error

fn from_json<T>(json: T) -> Result<Self, Self::Err>

where T: AsRef<[u8]>,

Deserialize JSON

fn as_json(&self) -> String

Serialize as JSON string

fn try_as_json(&self) -> Result<String, Self::Err>

Serialize as JSON string

fn as_pretty_json(&self) -> String

Serialize as pretty JSON string

fn try_as_pretty_json(&self) -> Result<String, Self::Err>

Serialize as pretty JSON string

impl Ord for Filter

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Filter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Filter

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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 StructuralPartialEq for Filter