Struct ironoxide::group::GroupCreateOpts
source · pub struct GroupCreateOpts { /* private fields */ }
Expand description
Options for group creation.
Default values are provided with GroupCreateOpts::default()
Implementations§
source§impl GroupCreateOpts
impl GroupCreateOpts
sourcepub 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
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 ifadd_as_admin
is false.
- The list of users to be added as group admins. This list takes priority over
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 ifadd_as_member
is false.
- The list of users to be added as members of the group. This list takes priority over
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§
source§impl Clone for GroupCreateOpts
impl Clone for GroupCreateOpts
source§fn clone(&self) -> GroupCreateOpts
fn clone(&self) -> GroupCreateOpts
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for GroupCreateOpts
impl Debug for GroupCreateOpts
source§impl Default for GroupCreateOpts
impl Default for GroupCreateOpts
source§fn default() -> Self
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.
source§impl Hash for GroupCreateOpts
impl Hash for GroupCreateOpts
source§impl PartialEq for GroupCreateOpts
impl PartialEq for GroupCreateOpts
source§fn eq(&self, other: &GroupCreateOpts) -> bool
fn eq(&self, other: &GroupCreateOpts) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Eq for GroupCreateOpts
impl StructuralEq for GroupCreateOpts
impl StructuralPartialEq for GroupCreateOpts
Auto Trait Implementations§
impl RefUnwindSafe for GroupCreateOpts
impl Send for GroupCreateOpts
impl Sync for GroupCreateOpts
impl Unpin for GroupCreateOpts
impl UnwindSafe for GroupCreateOpts
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<T> InitializableFromZeroed for Twhere
T: Default,
impl<T> InitializableFromZeroed for Twhere T: Default,
§unsafe fn initialize(place: *mut T)
unsafe fn initialize(place: *mut T)
Called to initialize a place to a valid value, after it is set
to all-bits-zero. Read more