Struct ironoxide::group::GroupCreateOpts[−][src]

pub struct GroupCreateOpts { /* fields omitted */ }

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]

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[src]

fn clone(&self) -> GroupCreateOpts[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for GroupCreateOpts[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

Formats the value using the given formatter. Read more

impl Default for GroupCreateOpts[src]

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 Hash for GroupCreateOpts[src]

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

Feeds this value into the given Hasher. Read more

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

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<GroupCreateOpts> for GroupCreateOpts[src]

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

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

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

This method tests for !=.

impl Eq for GroupCreateOpts[src]

impl StructuralEq for GroupCreateOpts[src]

impl StructuralPartialEq for GroupCreateOpts[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Clear for T where
    T: InitializableFromZeroed + ?Sized, 

pub fn clear(&mut self)

Completely overwrites this value.

impl<Q, K> Equivalent<K> for Q where
    Q: Eq + ?Sized,
    K: Borrow<Q> + ?Sized, [src]

pub fn equivalent(&self, key: &K) -> bool[src]

Compare self to key and return true if they are equal.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> InitializableFromZeroed for T where
    T: Default, 

pub 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

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

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]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V