Struct Invite 

pub struct Invite {

    pub inviter_device_pubkey: DevicePubkey,
    pub inviter_ephemeral_public_key: DevicePubkey,
    pub shared_secret: [u8; 32],
    pub inviter_ephemeral_private_key: Option<[u8; 32]>,
    pub max_uses: Option<usize>,
    pub used_by: Vec<DevicePubkey>,
    pub used_response_contents: Vec<String>,
    pub created_at: UnixSeconds,
    pub inviter_owner_pubkey: Option<OwnerPubkey>,
    pub purpose: Option<String>,
    pub inviter: PublicKey,
    pub device_id: Option<String>,
    pub owner_public_key: Option<PublicKey>,
}

Fields

inviter_device_pubkey: DevicePubkey

inviter_ephemeral_public_key: DevicePubkey

shared_secret: [u8; 32]

inviter_ephemeral_private_key: Option<[u8; 32]>

max_uses: Option<usize>

used_by: Vec<DevicePubkey>

used_response_contents: Vec<String>

created_at: UnixSeconds

inviter_owner_pubkey: Option<OwnerPubkey>

purpose: Option<String>

inviter: PublicKey

device_id: Option<String>

owner_public_key: Option<PublicKey>

Implementations

impl Invite

pub fn create_new( inviter: PublicKey, device_id: Option<String>, max_uses: Option<usize>, ) -> Result<Invite, Error>

pub fn create_new_with_context<R>( ctx: &mut ProtocolContext<'_, R>, inviter_device_pubkey: DevicePubkey, inviter_owner_pubkey: Option<OwnerPubkey>, max_uses: Option<usize>, ) -> Result<Invite, Error>

where R: RngCore + CryptoRng,

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

pub fn deserialize(json: &str) -> Result<Invite, Error>

pub fn accept( &self, invitee_public_key: PublicKey, invitee_private_key: [u8; 32], device_id: Option<String>, ) -> Result<(Session, InviteResponseEnvelope), Error>

pub fn accept_with_owner( &self, invitee_public_key: PublicKey, invitee_private_key: [u8; 32], device_id: Option<String>, owner_public_key: Option<PublicKey>, ) -> Result<(Session, InviteResponseEnvelope), Error>

pub fn accept_with_context<R>( &self, ctx: &mut ProtocolContext<'_, R>, invitee_public_key: DevicePubkey, invitee_private_key: [u8; 32], ) -> Result<(Session, InviteResponseEnvelope), Error>

where R: RngCore + CryptoRng,

pub fn accept_with_owner_context<R>( &self, ctx: &mut ProtocolContext<'_, R>, invitee_public_key: DevicePubkey, invitee_private_key: [u8; 32], invitee_owner_pubkey: Option<OwnerPubkey>, ) -> Result<(Session, InviteResponseEnvelope), Error>

where R: RngCore + CryptoRng,

pub fn process_response<R>( &mut self, ctx: &mut ProtocolContext<'_, R>, envelope: &InviteResponseEnvelope, inviter_private_key: [u8; 32], ) -> Result<InviteResponse, Error>

where R: RngCore + CryptoRng,

Trait Implementations

impl Clone for Invite

fn clone(&self) -> Invite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invite

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Invite

impl InviteNostrExt for Invite

fn get_url(&self, root: &str) -> Result<String, Error>

fn get_event(&self) -> Result<UnsignedEvent, Error>

fn from_url(url: &str) -> Result<Invite, Error>

fn from_event(event: &Event) -> Result<Invite, Error>

fn process_invite_response( &self, event: &Event, inviter_private_key: [u8; 32], ) -> Result<Option<InviteResponse>, Error>

impl PartialEq for Invite

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

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

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 Invite

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 StructuralPartialEq for Invite