Struct nostr_types::TagV3

source ·
pub struct TagV3(/* private fields */);
Expand description

A tag on an Event

Implementations§

source§

impl TagV3

source

pub fn new(fields: &[&str]) -> TagV3

Create a new tag

source

pub fn from_strings(fields: Vec<String>) -> TagV3

Create a new tag without copying

source

pub fn get_index(&self, index: usize) -> &str

Get the string at the given index

source

pub fn set_index(&mut self, index: usize, value: String)

Set the string at the given index

source

pub fn push_values(&mut self, values: Vec<String>)

Push more values onto the tag

source

pub fn tagname(&self) -> &str

Get the tag name for the tag (the first string in the array)

source

pub fn value(&self) -> &str

Get the tag value (index 1, after the tag name)

source

pub fn marker(&self) -> &str

Get the marker (if relevant), else “”

source

pub fn new_address(event_addr: &EventAddr, marker: Option<String>) -> TagV3

Create a new ‘a’ address tag

source

pub fn parse_address(&self) -> Result<(EventAddr, Option<String>), Error>

Parse an ‘a’ tag ['a', '30023:pubkeyhex:opturl', <optmarker>]

source

pub fn new_content_warning(warning: &str) -> TagV3

Create a “content-warning” tag

source

pub fn parse_content_warning(&self) -> Result<Option<String>, Error>

Parse a “content-warning” tag

source

pub fn new_event( id: Id, recommended_relay_url: Option<UncheckedUrl>, marker: Option<String> ) -> TagV3

Create an “e” tag

source

pub fn parse_event( &self ) -> Result<(Id, Option<UncheckedUrl>, Option<String>), Error>

Parse an “e” tag ['e', <id>, <rurl>, <marker>]

source

pub fn new_quote(id: Id, recommended_relay_url: Option<UncheckedUrl>) -> TagV3

Create a “q” tag

source

pub fn parse_quote(&self) -> Result<(Id, Option<UncheckedUrl>), Error>

Parse a “q” tag

source

pub fn new_pubkey( pubkey: PublicKey, relay_url: Option<UncheckedUrl>, petname: Option<String> ) -> TagV3

Create a “p” tag

source

pub fn parse_pubkey( &self ) -> Result<(PublicKey, Option<UncheckedUrl>, Option<String>), Error>

Parse a “p” tag

source

pub fn new_hashtag(hashtag: String) -> TagV3

Create a “t” tag

source

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

Parse an “t” tag

source

pub fn new_relay(url: UncheckedUrl, usage: Option<String>) -> TagV3

Create an “r” tag

source

pub fn parse_relay(&self) -> Result<(UncheckedUrl, Option<String>), Error>

Parse an “r” tag

source

pub fn new_identifier(identifier: String) -> TagV3

Create a “d” tag

source

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

Parse a “d” tag

source

pub fn new_subject(subject: String) -> TagV3

Create a “subject” tag

source

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

Parse a “subject” tag

source

pub fn new_nonce(nonce: u32, target: Option<u32>) -> TagV3

Create a “nonce” tag

source

pub fn parse_nonce(&self) -> Result<(u32, Option<u32>), Error>

Parse a “nonce” tag

source

pub fn new_title(title: String) -> TagV3

Create a “title” tag

source

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

Parse a “title” tag

source

pub fn new_summary(summary: String) -> TagV3

Create a “summary” tag

source

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

Parse a “summary” tag

source

pub fn new_kind(kind: EventKind) -> TagV3

Create a “k” tag

source

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

Parse a “k” tag

source

pub fn new_delegation( pubkey: PublicKey, conditions: DelegationConditions, sig: Signature ) -> TagV3

New delegation tag

source

pub fn parse_delegation( &self ) -> Result<(PublicKey, DelegationConditions, Signature), Error>

parse delegation tag

source

pub fn proxy(protocol: String, id: String) -> TagV3

New proxy tag

source

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

parse proxy tag

Trait Implementations§

source§

impl Clone for TagV3

source§

fn clone(&self) -> TagV3

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TagV3

source§

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

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

impl<'de> Deserialize<'de> for TagV3

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq for TagV3

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl<'a_, C_: Context> Readable<'a_, C_> for TagV3

source§

fn read_from<R_: Reader<'a_, C_>>(_reader_: &mut R_) -> Result<Self, C_::Error>

source§

fn minimum_bytes_needed() -> usize

§

fn read_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> Result<Self, <C as Context>::Error>

§

fn read_with_length_from_buffer_with_ctx( context: C, buffer: &'a [u8] ) -> (Result<Self, <C as Context>::Error>, usize)

§

fn read_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> Result<Self, <C as Context>::Error>

§

fn read_with_length_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

§

fn read_with_length_from_buffer_copying_data_with_ctx_mut( context: &mut C, buffer: &[u8] ) -> (Result<Self, <C as Context>::Error>, usize)

§

fn read_from_stream_unbuffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>
where S: Read,

§

fn read_from_stream_buffered_with_ctx<S>( context: C, stream: S ) -> Result<Self, <C as Context>::Error>
where S: Read,

§

fn read_from_file_with_ctx( context: C, path: impl AsRef<Path> ) -> Result<Self, <C as Context>::Error>

source§

impl Serialize for TagV3

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<C_: Context> Writable<C_> for TagV3

source§

fn write_to<T_: ?Sized + Writer<C_>>( &self, _writer_: &mut T_ ) -> Result<(), C_::Error>

§

fn write_to_buffer_with_ctx( &self, context: C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

§

fn write_to_buffer_with_ctx_mut( &self, context: &mut C, buffer: &mut [u8] ) -> Result<(), <C as Context>::Error>

§

fn write_to_vec_with_ctx( &self, context: C ) -> Result<Vec<u8>, <C as Context>::Error>

§

fn write_to_vec_with_ctx_mut( &self, context: &mut C ) -> Result<Vec<u8>, <C as Context>::Error>

§

fn write_to_stream_with_ctx<S>( &self, context: C, stream: S ) -> Result<(), <C as Context>::Error>
where S: Write,

§

fn write_to_file_with_ctx( &self, context: C, path: impl AsRef<Path> ) -> Result<(), <C as Context>::Error>

§

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

source§

impl Eq for TagV3

source§

impl StructuralPartialEq for TagV3

Auto Trait Implementations§

§

impl RefUnwindSafe for TagV3

§

impl Send for TagV3

§

impl Sync for TagV3

§

impl Unpin for TagV3

§

impl UnwindSafe for TagV3

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<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.
§

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

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,