Struct UserGroup 

pub struct UserGroup { /* private fields */ }

Represents the user group’s attributes.

Modified from openapi-generator-cli output:

$ openapi-generator-cli generate -g rust -i ./zerver/openapi/zulip.yaml -o zulip-openapi --skip-validate-spec

/*
* Zulip REST API
*
* Powerful open source group chat
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/

See zerver/openapi/zulip.yaml for the original OpenAPI configuration.

Configuration slightly modified to work with the Rust generator of openapi-generator-cli.

Implementations

impl UserGroup

pub const fn new() -> Self

Creates a new UserGroup.

impl UserGroup

pub fn name(&self) -> Option<&str>

Gets the UserGroup name.

The name of the user group.

pub fn set_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the UserGroup name.

The name of the user group.

pub fn unset_name(&mut self) -> Option<String>

Unsets the UserGroup name.

The name of the user group.

pub fn with_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the UserGroup name.

The name of the user group.

pub fn description(&self) -> Option<&str>

Gets the UserGroup description.

The description of the user group.

pub fn set_description<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the UserGroup description.

The description of the user group.

pub fn unset_description(&mut self) -> Option<String>

Unsets the UserGroup description.

The description of the user group.

pub fn with_description<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the UserGroup description.

The description of the user group.

pub fn members(&self) -> Option<&[u64]>

Gets the UserGroup members.

Array containing the ID of the users who are members of this user group.

Changes: Prior to Zulip 10.0 (feature level 303), this list also included deactivated users who were members of the user group before being deactivated.

pub fn set_members<'a, C: Into<Cow<'a, [u64]>>>(&mut self, val: C)

Sets the UserGroup members.

Array containing the ID of the users who are members of this user group.

Changes: Prior to Zulip 10.0 (feature level 303), this list also included deactivated users who were members of the user group before being deactivated.

pub fn unset_members(&mut self) -> Option<Vec<u64>>

Unsets the UserGroup members.

Array containing the ID of the users who are members of this user group.

Changes: Prior to Zulip 10.0 (feature level 303), this list also included deactivated users who were members of the user group before being deactivated.

pub fn with_members<'a, C: Into<Cow<'a, [u64]>>>(self, val: C) -> Self

Builder function that sets the UserGroup members.

Array containing the ID of the users who are members of this user group.

Changes: Prior to Zulip 10.0 (feature level 303), this list also included deactivated users who were members of the user group before being deactivated.

pub fn direct_subgroup_ids(&self) -> Option<&[u64]>

Gets the UserGroup direct_subgroup_ids.

Array containing the ID of the direct_subgroups of this user group.

Changes: New in Zulip 6.0 (feature level 131).

Introduced in feature level 127 as subgroups, but clients can ignore older events as this feature level predates subgroups being fully implemented.

pub fn set_direct_subgroup_ids<'a, C: Into<Cow<'a, [u64]>>>(&mut self, val: C)

Sets the UserGroup direct_subgroup_ids.

Array containing the ID of the direct_subgroups of this user group.

Changes: New in Zulip 6.0 (feature level 131).

Introduced in feature level 127 as subgroups, but clients can ignore older events as this feature level predates subgroups being fully implemented.

pub fn unset_direct_subgroup_ids(&mut self) -> Option<Vec<u64>>

Unsets the UserGroup direct_subgroup_ids.

Array containing the ID of the direct_subgroups of this user group.

Changes: New in Zulip 6.0 (feature level 131).

Introduced in feature level 127 as subgroups, but clients can ignore older events as this feature level predates subgroups being fully implemented.

pub fn with_direct_subgroup_ids<'a, C: Into<Cow<'a, [u64]>>>( self, val: C, ) -> Self

Builder function that sets the UserGroup direct_subgroup_ids.

Array containing the ID of the direct_subgroups of this user group.

Changes: New in Zulip 6.0 (feature level 131).

Introduced in feature level 127 as subgroups, but clients can ignore older events as this feature level predates subgroups being fully implemented.

impl UserGroup

pub const fn date_created(&self) -> Option<u64>

Gets the UserGroup date_created.

The UNIX timestamp for when the user group was created, in UTC seconds.

A null value means the user group has no recorded date, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub fn set_date_created(&mut self, val: u64)

Sets the UserGroup date_created.

The UNIX timestamp for when the user group was created, in UTC seconds.

A null value means the user group has no recorded date, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub fn unset_date_created(&mut self) -> Option<u64>

Unsets the UserGroup date_created.

The UNIX timestamp for when the user group was created, in UTC seconds.

A null value means the user group has no recorded date, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub fn with_date_created(self, val: u64) -> Self

Builder function that sets the UserGroup date_created.

The UNIX timestamp for when the user group was created, in UTC seconds.

A null value means the user group has no recorded date, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub const fn creator_id(&self) -> Option<u64>

Gets the UserGroup creator_id.

The ID of the user who created this user group.

A null value means the user group has no recorded creator, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub fn set_creator_id(&mut self, val: u64)

Sets the UserGroup creator_id.

The ID of the user who created this user group.

A null value means the user group has no recorded creator, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub fn unset_creator_id(&mut self) -> Option<u64>

Unsets the UserGroup creator_id.

The ID of the user who created this user group.

A null value means the user group has no recorded creator, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub fn with_creator_id(self, val: u64) -> Self

Builder function that sets the UserGroup creator_id.

The ID of the user who created this user group.

A null value means the user group has no recorded creator, which is often because the user group is very old,

or because it was created via a data import tool or management command.

Changes: New in Zulip 10.0 (feature level 292).

pub const fn id(&self) -> Option<u64>

Gets the UserGroup id.

The ID of the user group.

pub fn set_id(&mut self, val: u64)

Sets the UserGroup id.

The ID of the user group.

pub fn unset_id(&mut self) -> Option<u64>

Unsets the UserGroup id.

The ID of the user group.

pub fn with_id(self, val: u64) -> Self

Builder function that sets the UserGroup id.

The ID of the user group.

pub const fn is_system_group(&self) -> Option<bool>

Gets the UserGroup is_system_group.

Whether the user group is a system group which cannot be directly modified by users.

Changes: New in Zulip 5.0 (feature level 93).

pub fn set_is_system_group(&mut self, val: bool)

Sets the UserGroup is_system_group.

Whether the user group is a system group which cannot be directly modified by users.

Changes: New in Zulip 5.0 (feature level 93).

pub fn unset_is_system_group(&mut self) -> Option<bool>

Unsets the UserGroup is_system_group.

Whether the user group is a system group which cannot be directly modified by users.

Changes: New in Zulip 5.0 (feature level 93).

pub fn with_is_system_group(self, val: bool) -> Self

Builder function that sets the UserGroup is_system_group.

Whether the user group is a system group which cannot be directly modified by users.

Changes: New in Zulip 5.0 (feature level 93).

pub const fn deactivated(&self) -> Option<bool>

Gets the UserGroup deactivated.

Whether the user group is deactivated.

Deactivated groups cannot be used as a subgroup of another group or used for any other purpose.

Changes: New in Zulip 10.0 (feature level 290).

pub fn set_deactivated(&mut self, val: bool)

Sets the UserGroup deactivated.

Whether the user group is deactivated.

Deactivated groups cannot be used as a subgroup of another group or used for any other purpose.

Changes: New in Zulip 10.0 (feature level 290).

pub fn unset_deactivated(&mut self) -> Option<bool>

Unsets the UserGroup deactivated.

Whether the user group is deactivated.

Deactivated groups cannot be used as a subgroup of another group or used for any other purpose.

Changes: New in Zulip 10.0 (feature level 290).

pub fn with_deactivated(self, val: bool) -> Self

Builder function that sets the UserGroup deactivated.

Whether the user group is deactivated.

Deactivated groups cannot be used as a subgroup of another group or used for any other purpose.

Changes: New in Zulip 10.0 (feature level 290).

impl UserGroup

pub fn can_add_members_group(&self) -> Option<&GroupSetting>

Gets the UserGroup can_add_members_group.

A GroupSetting defining the set of users who have permission to add members to this user group.

pub fn set_can_add_members_group(&mut self, val: GroupSetting)

Sets the UserGroup can_add_members_group.

A GroupSetting defining the set of users who have permission to add members to this user group.

pub fn unset_can_add_members_group(&mut self) -> Option<GroupSetting>

Unsets the UserGroup can_add_members_group.

A GroupSetting defining the set of users who have permission to add members to this user group.

pub fn with_can_add_members_group(self, val: GroupSetting) -> Self

Builder function that sets the UserGroup can_add_members_group.

A GroupSetting defining the set of users who have permission to add members to this user group.

pub fn can_join_group(&self) -> Option<&GroupSetting>

Gets the UserGroup can_join_group.

A GroupSetting defining the set of users who have permission to join this user group.

pub fn set_can_join_group(&mut self, val: GroupSetting)

Sets the UserGroup can_join_group.

A GroupSetting defining the set of users who have permission to join this user group.

pub fn unset_can_join_group(&mut self) -> Option<GroupSetting>

Unsets the UserGroup can_join_group.

A GroupSetting defining the set of users who have permission to join this user group.

pub fn with_can_join_group(self, val: GroupSetting) -> Self

Builder function that sets the UserGroup can_join_group.

A GroupSetting defining the set of users who have permission to join this user group.

pub fn can_leave_group(&self) -> Option<&GroupSetting>

Gets the UserGroup can_leave_group.

A GroupSetting defining the set of users who have permission to leave this user group.

pub fn set_can_leave_group(&mut self, val: GroupSetting)

Sets the UserGroup can_leave_group.

A GroupSetting defining the set of users who have permission to leave this user group.

pub fn unset_can_leave_group(&mut self) -> Option<GroupSetting>

Unsets the UserGroup can_leave_group.

A GroupSetting defining the set of users who have permission to leave this user group.

pub fn with_can_leave_group(self, val: GroupSetting) -> Self

Builder function that sets the UserGroup can_leave_group.

A GroupSetting defining the set of users who have permission to leave this user group.

pub fn can_manage_group(&self) -> Option<&GroupSetting>

Gets the UserGroup can_manage_group.

A GroupSetting defining the set of users who have permission to manage this user group.

pub fn set_can_manage_group(&mut self, val: GroupSetting)

Sets the UserGroup can_manage_group.

A GroupSetting defining the set of users who have permission to manage this user group.

pub fn unset_can_manage_group(&mut self) -> Option<GroupSetting>

Unsets the UserGroup can_manage_group.

A GroupSetting defining the set of users who have permission to manage this user group.

pub fn with_can_manage_group(self, val: GroupSetting) -> Self

Builder function that sets the UserGroup can_manage_group.

A GroupSetting defining the set of users who have permission to manage this user group.

pub fn can_mention_group(&self) -> Option<&GroupSetting>

Gets the UserGroup can_mention_group.

A GroupSetting defining the set of users who have permission to mention this user group.

pub fn set_can_mention_group(&mut self, val: GroupSetting)

Sets the UserGroup can_mention_group.

A GroupSetting defining the set of users who have permission to mention this user group.

pub fn unset_can_mention_group(&mut self) -> Option<GroupSetting>

Unsets the UserGroup can_mention_group.

A GroupSetting defining the set of users who have permission to mention this user group.

pub fn with_can_mention_group(self, val: GroupSetting) -> Self

Builder function that sets the UserGroup can_mention_group.

A GroupSetting defining the set of users who have permission to mention this user group.

pub fn can_remove_members_group(&self) -> Option<&GroupSetting>

Gets the UserGroup can_remove_members_group.

A GroupSetting defining the set of users who have permission to remove members from this user group.

pub fn set_can_remove_members_group(&mut self, val: GroupSetting)

Sets the UserGroup can_remove_members_group.

A GroupSetting defining the set of users who have permission to remove members from this user group.

pub fn unset_can_remove_members_group(&mut self) -> Option<GroupSetting>

Unsets the UserGroup can_remove_members_group.

A GroupSetting defining the set of users who have permission to remove members from this user group.

pub fn with_can_remove_members_group(self, val: GroupSetting) -> Self

Builder function that sets the UserGroup can_remove_members_group.

A GroupSetting defining the set of users who have permission to remove members from this user group.

Trait Implementations

impl Clone for UserGroup

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserGroup

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

Formats the value using the given formatter.

impl Default for UserGroup

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserGroup

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UserGroup

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

Formats the value using the given formatter.

impl PartialEq for UserGroup

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for UserGroup

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UserGroup