Struct Event

pub struct Event {
    pub id: Id,
    pub pubkey: PublicKey,
    pub created_at: Unixtime,
    pub kind: EventKind,
    pub tags: Vec<Tag>,
    pub content: String,
    pub ots: Option<String>,
    pub sig: Signature,
}

The main event type

Fields

id: Id

The Id of the event, generated as a SHA256 of the inner event data

pubkey: PublicKey

The public key of the actor who created the event

created_at: Unixtime

The (unverified) time at which the event was created

kind: EventKind

The kind of event

tags: Vec<Tag>

A set of tags that apply to the event

content: String

The content of the event

ots: Option<String>

An optional verified time for the event (using OpenTimestamp)

sig: Signature

The signature of the event, which cryptographically verifies that the holder of the PrivateKey matching the event’s PublicKey generated (or authorized) this event. The signature is taken over the id field only, but the id field is taken over the rest of the event data.

Implementations

impl Event

pub fn new(input: PreEvent, privkey: &PrivateKey) -> Result<Event, Error>

Create a new event

pub fn new_with_pow( input: PreEvent, privkey: &PrivateKey, zero_bits: u8, ) -> Result<Event, Error>

Create a new event with proof of work.

This can take a long time, and is only cancellable by killing the thread.

pub fn verify(&self, maxtime: Option<Unixtime>) -> Result<(), Error>

Check the validity of an event. This is useful if you deserialize an event from the network. If you create an event using new() it should already be trustworthy.

pub fn new_set_metadata( input: PreEvent, privkey: &PrivateKey, metadata: Metadata, ) -> Result<Event, Error>

Create an event that sets Metadata

pub fn new_zap_request( privkey: &PrivateKey, recipient_pubkey: PublicKeyHex, zapped_event: Option<Id>, millisatoshis: u64, relays: Vec<String>, content: String, ) -> Result<Event, Error>

Create a ZapRequest event These events are not published to nostr, they are sent to a lnurl.

pub fn decrypted_contents( &self, private_key: &PrivateKey, ) -> Result<String, Error>

If an event is an EncryptedDirectMessage, decrypt it’s contents

pub fn people(&self) -> Vec<(PublicKeyHex, Option<RelayUrl>, Option<String>)>

If the event refers to people, get all the PublicKeys it refers to along with recommended relay URL and petname for each

pub fn referenced_people( &self, ) -> Vec<(PublicKeyHex, Option<RelayUrl>, Option<String>)>

If the event refers to people, get all the PublicKeys it refers to along with recommended relay URL and petname for each, but only if they are referenced within the note.

pub fn is_reply(&self) -> bool

👎Deprecated since 0.2.0: please use replies_to instead

Is the event a reply?

pub fn replies_to(&self) -> Option<(Id, Option<RelayUrl>)>

If this event replies to another, get that other event’s Id along with an optional recommended_relay_url

pub fn replies_to_root(&self) -> Option<(Id, Option<RelayUrl>)>

If this event replies to a thread, get that threads root event Id if available, along with an optional recommended_relay_url

pub fn replies_to_ancestors(&self) -> Vec<(Id, Option<RelayUrl>)>

If this event replies to a thread, get all ancestors in that thread. This also gets all mentioned events.

pub fn mentions(&self) -> Vec<(Id, Option<RelayUrl>)>

If this event mentions others, get those other event Ids and optional recommended relay Urls

pub fn reacts_to(&self) -> Option<(Id, String, Option<RelayUrl>)>

If this event reacts to another, get that other event’s Id, the reaction content, and an optional Recommended relay Url

pub fn deletes(&self) -> Option<(Vec<Id>, String)>

If this event deletes others, get all the Ids of the events that it deletes along with the reason for the deletion

pub fn client(&self) -> Option<String>

If this event specifies the client that created it, return that client string

pub fn subject(&self) -> Option<String>

If this event specifies a subject, return that subject string

pub fn content_warning(&self) -> Option<String>

If this event specifies a content warning, return that subject string

pub fn hashtags(&self) -> Vec<String>

Return all the hashtags this event refers to

pub fn urls(&self) -> Vec<RelayUrl>

Return all the URLs this event refers to

pub fn pow(&self) -> u8

Get the proof-of-work count of leading bits

pub fn delegation(&self) -> EventDelegation

Was this event delegated, was that valid, and if so what is the pubkey of the delegator?

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

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

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

const 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 Serialize for Event

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 Event

impl StructuralPartialEq for Event