Struct zkgroup::api::groups::GroupSendEndorsement

pub struct GroupSendEndorsement<Storage = RistrettoPoint> { /* private fields */ }

A single endorsement, for one or multiple group members.

Storage is usually [curve25519_dalek_signal::RistrettoPoint], but the receive APIs on GroupSendEndorsementsResponse produce “compressed” endorsements, since they are usually immediately serialized.

Implementations

impl GroupSendEndorsement<CompressedRistretto>

pub fn decompress( self, ) -> Result<GroupSendEndorsement<RistrettoPoint>, ZkGroupDeserializationFailure>

Attempts to decompress the GroupSendEndorsement.

Produces ZkGroupDeserializationFailure if the compressed storage isn’t a valid representation of a point.

Deserializing an GroupSendEndorsement<RistrettoPoint> is equivalent to deserializing an GroupSendEndorsement<CompressedRistretto> and then calling decompress.

impl GroupSendEndorsement<RistrettoPoint>

pub fn compress(self) -> GroupSendEndorsement<CompressedRistretto>

Compresses the GroupSendEndorsement for storage.

Serializing an GroupSendEndorsement<RistrettoPoint> is equivalent to calling compress and serializing the resulting GroupSendEndorsement<CompressedRistretto>.

impl GroupSendEndorsement

pub fn combine( endorsements: impl IntoIterator<Item = GroupSendEndorsement>, ) -> GroupSendEndorsement

Combines several endorsements into one.

All endorsements must have been generated from the same issuance, or the resulting endorsement will not produce a valid token.

This is a set-like operation: order does not matter.

pub fn remove( &self, unwanted_endorsements: &GroupSendEndorsement, ) -> GroupSendEndorsement

Removes endorsements from a previously-combined endorsement.

Removing endorsements not present in self will result in an endorsement that will not produce a valid token.

This is a set-like operation: order does not matter. Multiple endorsements can be removed by calling this method repeatedly, or by removing a single combined endorsement.

pub fn to_token(&self, group_params: &GroupSecretParams) -> GroupSendToken

Generates a bearer token from the endorsement.

This can be cached by the client for repeatedly sending to the same recipient, but must be converted to a GroupSendFullToken before sending it to the server.

Trait Implementations

impl<Storage: Clone> Clone for GroupSendEndorsement<Storage>

fn clone(&self) -> GroupSendEndorsement<Storage>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupSendEndorsement<RistrettoPoint>

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

Formats the value using the given formatter.

impl Debug for GroupSendEndorsement<CompressedRistretto>

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

Formats the value using the given formatter.

impl<'de, Storage> Deserialize<'de> for GroupSendEndorsement<Storage>

where Storage: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Storage> PartialDefault for GroupSendEndorsement<Storage>

where Storage: Identity,

fn partial_default() -> Self

Returns a value that can be safely dropped or assigned over.

impl<Storage> PartialEq for GroupSendEndorsement<Storage>

where Storage: ConstantTimeEq,

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<Storage> Serialize for GroupSendEndorsement<Storage>

where Storage: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Storage: Copy> Copy for GroupSendEndorsement<Storage>