[−][src]Struct ironoxide::group::GroupCreateOpts
Options for group creation.
Default values are provided with GroupCreateOpts::default()
Implementations
impl GroupCreateOpts
[src]
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
[src]
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
impl Clone for GroupCreateOpts
[src]
pub fn clone(&self) -> GroupCreateOpts
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for GroupCreateOpts
[src]
impl Default for GroupCreateOpts
[src]
pub fn default() -> Self
[src]
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 Eq for GroupCreateOpts
[src]
impl Hash for GroupCreateOpts
[src]
pub fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl PartialEq<GroupCreateOpts> for GroupCreateOpts
[src]
pub fn eq(&self, other: &GroupCreateOpts) -> bool
[src]
pub fn ne(&self, other: &GroupCreateOpts) -> bool
[src]
impl StructuralEq for GroupCreateOpts
[src]
impl StructuralPartialEq for GroupCreateOpts
[src]
Auto Trait Implementations
impl RefUnwindSafe for GroupCreateOpts
[src]
impl Send for GroupCreateOpts
[src]
impl Sync for GroupCreateOpts
[src]
impl Unpin for GroupCreateOpts
[src]
impl UnwindSafe for GroupCreateOpts
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Clear for T where
T: InitializableFromZeroed + ?Sized,
T: InitializableFromZeroed + ?Sized,
pub fn clear(&mut self)
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
[src]
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> InitializableFromZeroed for T where
T: Default,
T: Default,
pub unsafe fn initialize(place: *mut T)
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,