Skip to main content

Comment

Struct Comment 

Source
pub struct Comment {
    pub root: CommentScope,
    pub root_kind: Option<Kind>,
    pub root_author: Option<PublicKey>,
    pub parent: CommentScope,
    pub parent_kind: Option<Kind>,
    pub parent_author: Option<PublicKey>,
    pub content: String,
}
Expand description

A NIP-22 kind: 1111 comment ready to be turned into an Event.

Both root and parent are mandatory; if the comment replies directly to the root, set both fields to the same scope.

§Spec note on K / P tags

NIP-22 declares that the K (root kind) and P (root pubkey) tags “MUST be” present alongside an E/A root scope. The crate stores them as Options for two practical reasons:

  • the CommentScope::External flavour has no inherent kind or author (the comment targets a URL, podcast, or NIP-73 identifier),
  • real-world events from Coracle, Damus and others sometimes ship a comment without the K/P columns, and the lenient parser would otherwise reject them.

Authors writing new NIP-22 events targeting CommentScope::Event / CommentScope::Address roots SHOULD set Self::root_kind (and the matching parent kind / author hints) so downstream relays can index the comment correctly.

Fields§

§root: CommentScope

Top of the conversation.

§root_kind: Option<Kind>

Optional kind hint for the root.

§root_author: Option<PublicKey>

Optional author hint for the root.

§parent: CommentScope

Direct parent (the message being replied to).

§parent_kind: Option<Kind>

Optional kind hint for the parent.

§parent_author: Option<PublicKey>

Optional author hint for the parent.

§content: String

Free-form comment text.

Implementations§

Source§

impl Comment

Source

pub fn top_level(root: CommentScope, content: impl Into<String>) -> Self

Construct a comment whose parent equals its root.

Source

pub const fn with_root_kind(self, kind: Kind) -> Self

Set the root kind hint.

Source

pub const fn with_root_author(self, author: PublicKey) -> Self

Set the root author hint.

Source

pub const fn with_parent_kind(self, kind: Kind) -> Self

Set the parent kind hint.

Source

pub const fn with_parent_author(self, author: PublicKey) -> Self

Set the parent author hint.

Source

pub fn with_parent(self, parent: CommentScope) -> Self

Override the parent scope (use when the parent differs from the root).

Source

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

Render the comment as the Tags that go into its kind: 1111 event.

Source

pub fn from_event(event: &Event) -> Result<Self, CommentError>

Reconstruct a Comment from a kind: 1111 Event.

§Errors

Returns the matching CommentError when the event is the wrong kind, missing one of the required scope tags, or carries malformed values.

Trait Implementations§

Source§

impl Clone for Comment

Source§

fn clone(&self) -> Comment

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Comment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Comment

Source§

impl PartialEq for Comment

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Comment

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more