Struct Event 

#[non_exhaustive]
pub struct Event {
    pub id: EventId,
    pub pubkey: PublicKey,
    pub created_at: Timestamp,
    pub kind: Kind,
    pub tags: Tags,
    pub content: String,
    pub sig: Signature,
}

Nostr event

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: EventId

ID

pubkey: PublicKey

Author

created_at: Timestamp

UNIX timestamp (seconds)

kind: Kind

Kind

tags: Tags

Tag list

content: String

Content

sig: Signature

Signature

Implementations

impl Event

pub fn new<I, S>( id: EventId, public_key: PublicKey, created_at: Timestamp, kind: Kind, tags: I, content: S, sig: Signature, ) -> Event

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

Compose event

pub fn verify(&self) -> Result<(), Error>

Verify both EventId and Signature

pub fn verify_with_ctx<C>(&self, secp: &Secp256k1<C>) -> Result<(), Error>

where C: Verification,

Verify both EventId and Signature

pub fn verify_id(&self) -> bool

Verify if the EventId it’s composed correctly

pub fn verify_signature(&self) -> bool

Verify only event Signature

pub fn verify_signature_with_ctx<C>(&self, secp: &Secp256k1<C>) -> bool

where C: Verification,

Verify event signature

pub fn check_pow(&self, difficulty: u8) -> bool

Check POW

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

pub fn is_expired(&self) -> bool

Returns true if the event has an expiration tag that is expired. If an event has no expiration tag, then it will return false.

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

pub fn is_expired_with_supplier<T>(&self, supplier: &T) -> bool

where T: TimeSupplier,

Returns true if the event has an expiration tag that is expired. If an event has no expiration tag, then it will return false.

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

pub fn is_expired_at(&self, now: &Timestamp) -> bool

Returns true if the event has an expiration tag that is expired. If an event has no expiration tag, then it will return false.

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

pub fn coordinate(&self) -> Option<CoordinateBorrow<'_>>

Get the coordinate of this event

Return a coordinate only if the event kind is replaceable or addressable.

pub fn is_protected(&self) -> bool

Check if it’s a protected event

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

Trait Implementations

impl AsRef<Event> for VerifiedEvent

fn as_ref(&self) -> &Event

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D, ) -> Result<Event, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Event

impl Hash for Event

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

where H: Hasher,

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 Event

fn from_json<T>(json: T) -> Result<Event, <Event as JsonUtil>::Err>

where T: AsRef<[u8]>,

Deserialize Event from JSON

This method doesn’t verify the signature!

type Err = Error

Error

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 Event

fn cmp(&self, other: &Event) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Event

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Event

fn partial_cmp(&self, other: &Event) -> 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 Event

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBech32 for Event

type Err = Error

fn to_bech32(&self) -> Result<String, <Event as ToBech32>::Err>

impl ToNostrUri for Event

fn to_nostr_uri(&self) -> Result<String, Error>

Get nostr URI

impl TryFrom<Event> for VerifiedEvent

type Error = String

The type returned in the event of a conversion error.

fn try_from(event: Event) -> Result<Self, Self::Error>

Performs the conversion.