Struct nostr::event::Event

pub struct Event { /* private fields */ }

Event struct

Implementations

impl Event

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

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

Compose event

pub fn from_value(value: Value) -> Result<Self, Error>

Deserialize Event from Value

This method NOT verify the signature!

pub fn id(&self) -> EventId

Get event ID

pub fn author(&self) -> PublicKey

Get event author (pubkey field)

pub fn author_ref(&self) -> &PublicKey

Get event author reference (pubkey field)

pub fn created_at(&self) -> Timestamp

Get Timestamp of when the event was created

pub fn kind(&self) -> Kind

Get event Kind

pub fn tags(&self) -> &[Tag]

Get reference to event tags

pub fn iter_tags(&self) -> impl Iterator<Item = &Tag>

Iterate event tags

pub fn into_iter_tags(self) -> impl Iterator<Item = Tag>

Iterate and consume event tags

pub fn content(&self) -> &str

Get reference to event content

pub fn signature(&self) -> Signature

Get event signature

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

Available on crate feature std only.

Verify both EventId and Signature

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

where C: Verification,

Verify EventId and Signature

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

Verify if the EventId it’s composed correctly

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

Available on crate feature std only.

Verify only event Signature

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

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 expiration(&self) -> Option<&Timestamp>

Get Timestamp expiration if set

pub fn is_expired(&self) -> bool

Available on crate feature std only.

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 is_job_request(&self) -> bool

Check if Kind is a NIP90 job request

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

pub fn is_job_result(&self) -> bool

Check if Kind is a NIP90 job result

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

pub fn is_regular(&self) -> bool

Check if event Kind is Regular

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

pub fn is_replaceable(&self) -> bool

Check if event Kind is Replaceable

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

pub fn is_ephemeral(&self) -> bool

Check if event Kind is Ephemeral

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

pub fn is_parameterized_replaceable(&self) -> bool

Check if event Kind is Parameterized replaceable

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

pub fn identifier(&self) -> Option<&str>

Extract identifier (d tag), if exists.

pub fn public_keys(&self) -> impl Iterator<Item = &PublicKey>

Extract public keys from tags (p tag)

This method extract ONLY TagStandard::PublicKey

pub fn event_ids(&self) -> impl Iterator<Item = &EventId>

Extract event IDs from tags (e tag)

This method extract ONLY TagStandard::Event

pub fn coordinates(&self) -> impl Iterator<Item = &Coordinate>

Extract coordinates from tags (a tag)

pub fn tags_indexes(&self) -> &TagsIndexes

Available on crate feature std only.

Get tags indexes

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy 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

Formats the value using the given formatter.

impl Deref for Event

type Target = EventIntermediate

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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 From<Event> for UnsignedEvent

fn from(event: Event) -> Self

Converts to this type from the input type.

impl Hash for Event

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

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<Self, Self::Err>

where T: AsRef<[u8]>,

Deserialize Event from JSON

This method NOT verify the signature!

type Err = Error

Error

fn as_json(&self) -> String

Serialize to JSON string

fn try_as_json(&self) -> Result<String, Self::Err>

Serialize to JSON string

impl Ord for Event

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Event

fn eq(&self, other: &Self) -> 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 PartialOrd for Event

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RawEvent> for Event

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw: RawEvent) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Event