Struct nostr_types::Filter

pub struct Filter {
    pub ids: Vec<IdHex>,
    pub authors: Vec<PublicKeyHex>,
    pub kinds: Vec<EventKind>,
    pub tags: BTreeMap<char, Vec<String>>,
    pub since: Option<Unixtime>,
    pub until: Option<Unixtime>,
    pub limit: Option<usize>,
}

Filter which specify what events a client is looking for

Fields

ids: Vec<IdHex>

Events which match these ids

authors: Vec<PublicKeyHex>

Events which match these authors

kinds: Vec<EventKind>

Events which match these kinds

tags: BTreeMap<char, Vec<String>>

Events which match the given tags

since: Option<Unixtime>

Events occuring after this date

until: Option<Unixtime>

Events occuring before this date

limit: Option<usize>

A limit on the number of events to return in the initial query

Implementations

impl Filter

pub fn new() -> Filter

Create a new Filter object

pub fn add_id(&mut self, id_hex: &IdHex)

Add an Id to the filter.

pub fn del_id(&mut self, id_hex: &IdHex)

Delete an Id from the filter

pub fn add_author(&mut self, public_key_hex: &PublicKeyHex)

Add a PublicKey to the filter

pub fn del_author(&mut self, public_key_hex: &PublicKeyHex)

Delete a PublicKey from the filter

pub fn add_event_kind(&mut self, event_kind: EventKind)

Add an EventKind to the filter

pub fn del_event_kind(&mut self, event_kind: EventKind)

Delete an EventKind from the filter

pub fn add_tag_value(&mut self, letter: char, value: String)

Add a Tag value to a filter

pub fn del_tag_value(&mut self, letter: char, value: String)

Add a Tag value from a filter

pub fn set_tag_values(&mut self, letter: char, values: Vec<String>)

Set all values for a given tag

pub fn clear_tag_values(&mut self, letter: char)

Remove all Tag values of a given kind from a filter

pub fn tags_as_tags(&self) -> Vec<Tag>

Convert filter tags into a Vec<Tag>

pub fn event_matches(&self, e: &Event) -> bool

Does the event match the filter?

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 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<'a_, C_: Context> Readable<'a_, C_> for Filter

fn read_from<R_: Reader<'a_, C_>>(_reader_: &mut R_) -> Result<Self, C_::Error>

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut( context: &mut C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>

where S: Read,

fn read_from_stream_buffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>

where S: Read,

fn read_from_file_with_ctx( context: C, path: impl AsRef<Path> ) -> Result<Self, <C as Context>::Error>

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<C_: Context> Writable<C_> for Filter

fn write_to<T_: ?Sized + Writer<C_>>( &self, _writer_: &mut T_ ) -> Result<(), C_::Error>

fn write_to_buffer_with_ctx( &self, context: C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut( &self, context: &mut C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx( &self, context: C ) -> Result<Vec<u8>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut( &self, context: &mut C ) -> Result<Vec<u8>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>( &self, context: C, stream: S ) -> Result<(), <C as Context>::Error>

where S: Write,

fn write_to_file_with_ctx( &self, context: C, path: impl AsRef<Path> ) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Eq for Filter

impl StructuralPartialEq for Filter