Struct Group 

pub struct Group {
    pub tree: HashedLeanIMT<ELEMENT_SIZE, PoseidonHash>,
}

Fields

tree: HashedLeanIMT<ELEMENT_SIZE, PoseidonHash>

Hashed LeanIMT

Implementations

impl Group

pub fn new(members: &[Element]) -> Result<Self, SemaphoreError>

Creates a new instance of the Group with optional initial members

pub fn root(&self) -> Option<Element>

Returns the root hash of the tree, or None if the tree is empty

pub fn depth(&self) -> usize

Returns the depth of the tree

pub fn size(&self) -> usize

Returns the size of the tree (number of leaves)

pub fn members(&self) -> Vec<Element>

Returns the group members

pub fn index_of(&self, member: Element) -> Option<usize>

Returns the index of a member if it exists

pub fn add_member(&mut self, member: Element) -> Result<(), SemaphoreError>

Adds a new member to the group

pub fn add_members(&mut self, members: &[Element]) -> Result<(), SemaphoreError>

Adds a set of members to the group

pub fn update_member( &mut self, index: usize, member: Element, ) -> Result<(), SemaphoreError>

Updates a group member

pub fn remove_member(&mut self, index: usize) -> Result<(), SemaphoreError>

Removes a member from the group

pub fn generate_proof( &self, index: usize, ) -> Result<MerkleProof, SemaphoreError>

Creates a proof of membership for a member

pub fn verify_proof(proof: &MerkleProof) -> bool

Verifies a proof of membership for a member

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl Default for Group

fn default() -> Group

Returns the “default value” for a type.

impl PartialEq for Group

fn eq(&self, other: &Group) -> 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 Eq for Group

impl StructuralPartialEq for Group