logos-co
/
nomos-node
mirror of
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix: membership comments to documentation (#838) 

* rebased

* doc comment add

* fmt
This commit is contained in:
Deep Mondal 2024-10-22 16:43:29 +05:30 committed by GitHub
parent 03854f4c23
commit b0142d7173
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
nomos-da/network/subnetworks-assignations/src/lib.rs
View File

@ -4,25 +4,25 @@ use std::collections::HashSet;
use std::hash::Hash;
pub trait MembershipHandler {
// Subnetworks Id type
/// Subnetworks Id type
type NetworkId: Eq + Hash;
// Members Id type
/// Members Id type
type Id;
// Returns the set of NetworksIds an id is a member of
/// Returns the set of NetworksIds an id is a member of
fn membership(&self, id: &Self::Id) -> HashSet<Self::NetworkId>;
// True if the id is a member of a network_id, False otherwise
/// True if the id is a member of a network_id, False otherwise
fn is_member_of(&self, id: &Self::Id, network_id: &Self::NetworkId) -> bool {
self.membership(id).contains(network_id)
}
// Returns true if the member id is in the overall membership set
/// Returns true if the member id is in the overall membership set
fn is_allowed(&self, id: &Self::Id) -> bool;
// Returns the set of members in a subnetwork by its NetworkId
/// Returns the set of members in a subnetwork by its NetworkId
fn members_of(&self, network_id: &Self::NetworkId) -> HashSet<Self::Id>;
/// Returns the set of all members
fn members(&self) -> HashSet<Self::Id>;
}