Struct PolicySet 

pub struct PolicySet {
    pub add_member_policy: MembershipPolicies,
    pub remove_member_policy: MembershipPolicies,
    pub update_metadata_policy: HashMap<String, MetadataPolicies>,
    pub add_admin_policy: PermissionsPolicies,
    pub remove_admin_policy: PermissionsPolicies,
    pub update_permissions_policy: PermissionsPolicies,
}

Represents a set of policies for a group.

Fields

add_member_policy: MembershipPolicies

The policy for adding members to the group.

remove_member_policy: MembershipPolicies

The policy for removing members from the group.

update_metadata_policy: HashMap<String, MetadataPolicies>

The policies for updating metadata fields.

add_admin_policy: PermissionsPolicies

The policy for adding admins to the group.

remove_admin_policy: PermissionsPolicies

The policy for removing admins from the group.

update_permissions_policy: PermissionsPolicies

The policy for updating permissions.

Implementations

impl PolicySet

pub fn new( add_member_policy: MembershipPolicies, remove_member_policy: MembershipPolicies, update_metadata_policy: HashMap<String, MetadataPolicies>, add_admin_policy: PermissionsPolicies, remove_admin_policy: PermissionsPolicies, update_permissions_policy: PermissionsPolicies, ) -> Self

Creates a new PolicySet instance.

pub fn new_dm() -> Self

pub fn evaluate_commit(&self, commit: &ValidatedCommit) -> bool

The evaluate_commit function is the core function for client side verification that ValidatedCommit adheres to the XMTP permission policies set in the PolicySet.

Permissions are checked against the proposer of each action when available, not the committer. This allows one member to commit proposals created by another member, as long as the proposer had permission to create those proposals.

pub fn to_bytes(&self) -> Result<Vec<u8>, PolicyError>

Converts the PolicySet to a Vec<u8>.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, PolicyError>

Creates a PolicySet from a Vec<u8>.

Trait Implementations

impl Clone for PolicySet

fn clone(&self) -> PolicySet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolicySet

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

Formats the value using the given formatter.

impl Default for PolicySet

Implements the Default trait for PolicySet.

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PolicySet

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