[−][src]Struct ironoxide::group::GroupCreateOpts
Options for group creation.
Methods
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
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.
- None (default) - The creating user will be the owner of the group. Cannot be used if
admins
- List of users to be added as admins of the group. This list takes priority overadd_as_admin
, so the calling user will be added as a member if their id is in this list even ifadd_as_admin
is false.members
- List of users to be added as members of the group. This list takes priority overadd_as_member
, so the calling user will be added as a member if their id is in this list even ifadd_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
[src]
fn clone(&self) -> GroupCreateOpts
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for GroupCreateOpts
[src]
impl Default for GroupCreateOpts
[src]
fn default() -> Self
[src]
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
[src]
impl Hash for GroupCreateOpts
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl PartialEq<GroupCreateOpts> for GroupCreateOpts
[src]
fn eq(&self, other: &GroupCreateOpts) -> bool
[src]
fn ne(&self, other: &GroupCreateOpts) -> bool
[src]
impl StructuralEq for GroupCreateOpts
[src]
impl StructuralPartialEq for GroupCreateOpts
[src]
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
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,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Clear for T where
T: InitializableFromZeroed + ?Sized,
T: InitializableFromZeroed + ?Sized,
fn clear(&mut self)
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> InitializableFromZeroed for T where
T: Default,
T: Default,
unsafe fn initialize(place: *mut T)
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.
fn to_owned(&self) -> T
[src]
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.
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.
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>,