Struct Ndb 

pub struct Ndb { /* private fields */ }

A nostrdb context. Construct one of these with Ndb::new.

Implementations

impl Ndb

pub fn new(db_dir: &str, config: &Config) -> Result<Ndb, Error>

Construct a new nostrdb context. Takes a directory where the database is/will be located and a nostrdb config.

pub fn process_event_with( &self, json: &str, meta: IngestMetadata, ) -> Result<(), Error>

Ingest a relay or client sent event, with optional relay metadata. This function returns immediately and doesn’t provide any information on if ingestion was successful or not.

pub fn process_event(&self, json: &str) -> Result<(), Error>

Ingest a relay-sent event in the form ["EVENT","subid", {"id:"...}] This function returns immediately and doesn’t provide any information on if ingestion was successful or not.

pub fn process_client_event(&self, json: &str) -> Result<(), Error>

Ingest a client-sent event in the form ["EVENT", {"id:"...}] This function returns immediately and doesn’t provide any information on if ingestion was successful or not.

pub fn query<'a>( &self, txn: &'a Transaction, filters: &[Filter], max_results: i32, ) -> Result<Vec<QueryResult<'a>>, Error>

pub fn subscription_count(&self) -> u32

pub fn unsubscribe(&mut self, sub: Subscription) -> Result<(), Error>

pub fn subscribe(&self, filters: &[Filter]) -> Result<Subscription, Error>

pub fn poll_for_notes(&self, sub: Subscription, max_notes: u32) -> Vec<NoteKey>

pub async fn wait_for_notes( &self, sub_id: Subscription, max_notes: u32, ) -> Result<Vec<NoteKey>, Error>

pub fn get_profile_by_key<'a>( &self, transaction: &'a Transaction, key: ProfileKey, ) -> Result<ProfileRecord<'a>, Error>

pub fn get_profile_by_pubkey<'a>( &self, transaction: &'a Transaction, id: &[u8; 32], ) -> Result<ProfileRecord<'a>, Error>

pub fn get_note_metadata<'a>( &self, txn: &'a Transaction, id: &[u8; 32], ) -> Result<NoteMetadata<'a>, Error>

pub fn get_notekey_by_id( &self, txn: &Transaction, id: &[u8; 32], ) -> Result<NoteKey, Error>

pub fn get_profilekey_by_pubkey( &self, txn: &Transaction, pubkey: &[u8; 32], ) -> Result<ProfileKey, Error>

pub fn get_blocks_by_key<'a>( &self, txn: &'a Transaction, note_key: NoteKey, ) -> Result<Blocks<'a>, Error>

pub fn get_note_by_key<'a>( &self, transaction: &'a Transaction, note_key: NoteKey, ) -> Result<Note<'a>, Error>

pub fn get_note_by_id<'a>( &self, transaction: &'a Transaction, id: &[u8; 32], ) -> Result<Note<'a>, Error>

Get a note from the database. Takes a Transaction and a 32-byte Note Id

pub fn search_profile<'a>( &self, transaction: &'a Transaction, search: &str, limit: u32, ) -> Result<Vec<&'a [u8; 32]>, Error>

pub fn as_ptr(&self) -> *mut ndb

Get the underlying pointer to the context in C

Trait Implementations

impl Clone for Ndb

fn clone(&self) -> Ndb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ndb

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

Formats the value using the given formatter.