Struct ironoxide::group::GroupCreateOpts

pub struct GroupCreateOpts { /* private fields */ }

Options for group creation.

Default values are provided with GroupCreateOpts::default()

Implementations

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

Arguments

• id
  • None (default) - The server will assign the group’s ID.
  • Some - The provided ID will be used as the group’s ID.
• name
  • None (default) - The group will be created with no name.
  • Some - The provided name will be used as the group’s name.
• add_as_admin
  • true (default) - The creating user will be added as a group admin.
  • false - The creating user will not be a group admin.
• add_as_member
  • true (default) - The creating user will be added as a group member.
  • false - The creating user will not be a group member.
• owner
  • None (default) - The creating user will be the owner of the group.
  • Some - The provided user will be the owner of the group. This ID will automatically be added to the admin list.
• admins
  • The list of users to be added as group admins. This list takes priority over add_as_admin, so the calling user will be added as an admin if they are in this list even if add_as_admin is false.
• members
  • The 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 they are in this list even if add_as_member is false.
• needs_rotation
  • true - The group’s private key will be marked for rotation.
  • false (default) - The 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 group will be assigned an ID and have an empty name. The user who calls group_create will be the owner of the group as well as the only admin and member of the group. The group’s private key will not be marked for rotation.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GroupCreateOpts

impl StructuralEq for GroupCreateOpts

impl StructuralPartialEq for GroupCreateOpts