Struct nostr_db::Filter

pub struct Filter {
    pub ids: Option<Vec<String>>,
    pub authors: Option<Vec<String>>,
    pub kinds: Option<Vec<u64>>,
    pub since: Option<u64>,
    pub until: Option<u64>,
    pub limit: Option<u64>,
    pub search: Option<String>,
    pub tags: HashMap<Vec<u8>, TagList>,
    pub desc: bool,
    pub words: Option<Vec<Vec<u8>>>,
}

Events filter

NIP-01

Fields

ids: Option<Vec<String>>

a list of event ids or prefixes

authors: Option<Vec<String>>

a list of pubkeys or prefixes, the pubkey of an event must be one of these

kinds: Option<Vec<u64>>

a list of a kind numbers

since: Option<u64>

until: Option<u64>

limit: Option<u64>

search: Option<String>

Keyword search NIP-50 , keywords renamed to search

tags: HashMap<Vec<u8>, TagList>

tags starts with “#”, key tag length 1

desc: bool

Query by time descending order

words: Option<Vec<Vec<u8>>>

Implementations

impl Filter

pub fn default_limit(&mut self, limit: u64)

pub fn set_tags(&mut self, tags: HashMap<String, Vec<String>>)

pub fn match_id<K: AsRef<[u8]>>(ids: Option<&Vec<String>>, id: K) -> bool

pub fn match_author<P: AsRef<[u8]>, D: AsRef<[u8]>>( authors: Option<&Vec<String>>, pubkey: P, delegator: Option<D> ) -> bool

pub fn match_kind(kinds: Option<&Vec<u64>>, kind: u64) -> bool

pub fn match_tag<V: AsRef<[u8]>, I: AsRef<[(V, V)]>>( tags: &HashMap<Vec<u8>, TagList>, event_tags: I ) -> bool

pub fn match(&self, event: &EventIndex) -> bool

pub fn match_except_tag(&self, event: &EventIndex) -> bool

pub fn match_archived(&self, event: &ArchivedEventIndex) -> bool

pub fn match_archived_except_tag(&self, event: &ArchivedEventIndex) -> bool

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

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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

impl StructuralEq for Filter

impl StructuralPartialEq for Filter