Struct ironoxide::group::GroupCreateOpts

pub struct GroupCreateOpts { /* fields omitted */ }

Options for group creation.

Methods

impl GroupCreateOpts

pub fn new(
    id: Option<GroupId>,
    name: Option<GroupName>,
    add_as_admin: bool,
    add_as_member: bool,
    owner: Option<UserId>,
    admins: Vec<UserId>,
    members: Vec<UserId>,
    needs_rotation: bool
) -> GroupCreateOpts

Constructor. Also see default()

Arguments

• id - Unique id of a group within a segment. If none, the server will assign an id.
• name - Human readable name of the group. Does not need to be unique. Will not be encrypted.
• add_as_admin
  • true (default) - The creating user will be added as an admin of the group.
  • false - The creating user will not be an admin of the group.
• add_as_member
  • true (default) - The creating user will be added as a member of the group.
  • false - The creating user will not be a member of the group.
• owner - Specifies the owner of the group
  • None (default) - The creating user will be the owner of the group. Cannot be used if add_as_admin is set to false as the owner must be an admin.
  • Some(UserId) - The provided user will be the owner of the group. This ID will automatically be added to the admins list.
• admins - List of users to be added as admins of the group. This list takes priority over add_as_admin, so the calling user will be added as a member if their id is in this list even if add_as_admin is false.
• members - List of users to be added as members of the group. This list takes priority over add_as_member, so the calling user will be added as a member if their id is in this list even if add_as_member is false.
• needs_rotation
  • true - group's private key will be marked for rotation
  • false (default) - group's private key will not be marked for rotation

Trait Implementations

impl Clone for GroupCreateOpts

fn clone(&self) -> GroupCreateOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupCreateOpts

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

Formats the value using the given formatter.

impl Default for GroupCreateOpts

fn default() -> Self

Default GroupCreateOpts for common use cases. The user who calls group_create() will be the owner of the group as well as an admin and member of the group.

impl Eq for GroupCreateOpts

impl Hash for GroupCreateOpts

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<GroupCreateOpts> for GroupCreateOpts

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GroupCreateOpts) -> bool

This method tests for !=.

impl StructuralEq for GroupCreateOpts

impl StructuralPartialEq for GroupCreateOpts