Struct NeverSubscribed 

pub struct NeverSubscribed { /* private fields */ }

Represents one of the channels that is visible to the user, and the user has never been subscribed to.

Important for clients containing UI where one can browse channels to subscribe to.

Changes: Before Zulip 10.0 (feature level 362), archived channels did not appear in this list, even if the archived_channels client capability was declared by the client. Prior to Zulip 10.0 (feature level 349), if a user was in can_administer_channel_group of a channel that they never subscribed to, but not an organization administrator, the channel in question would not be part of this array.

Implementations

impl NeverSubscribed

pub const fn new() -> Self

Creates a new NeverSubscribed.

impl NeverSubscribed

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

Gets the NeverSubscribed stream_id.

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

Sets the NeverSubscribed stream_id.

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

Unsets the NeverSubscribed stream_id.

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

Builder function that sets the NeverSubscribed stream_id.

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

Gets the NeverSubscribed is_archived.

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

Sets the NeverSubscribed is_archived.

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

Unsets the NeverSubscribed is_archived.

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

Builder function that sets the NeverSubscribed is_archived.

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

Gets the NeverSubscribed date_created.

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

Sets the NeverSubscribed date_created.

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

Unsets the NeverSubscribed date_created.

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

Builder function that sets the NeverSubscribed date_created.

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

Gets the NeverSubscribed creator_id.

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

Sets the NeverSubscribed creator_id.

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

Unsets the NeverSubscribed creator_id.

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

Builder function that sets the NeverSubscribed creator_id.

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

Gets the NeverSubscribed invite_only.

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

Sets the NeverSubscribed invite_only.

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

Unsets the NeverSubscribed invite_only.

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

Builder function that sets the NeverSubscribed invite_only.

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

Gets the NeverSubscribed is_web_public.

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

Sets the NeverSubscribed is_web_public.

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

Unsets the NeverSubscribed is_web_public.

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

Builder function that sets the NeverSubscribed is_web_public.

pub const fn stream_post_policy(&self) -> Option<StreamPostPolicy>

Gets the NeverSubscribed stream_post_policy.

pub fn set_stream_post_policy(&mut self, val: StreamPostPolicy)

Sets the NeverSubscribed stream_post_policy.

pub fn unset_stream_post_policy(&mut self) -> Option<StreamPostPolicy>

Unsets the NeverSubscribed stream_post_policy.

pub fn with_stream_post_policy(self, val: StreamPostPolicy) -> Self

Builder function that sets the NeverSubscribed stream_post_policy.

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

Gets the NeverSubscribed message_retention_days.

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

Sets the NeverSubscribed message_retention_days.

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

Unsets the NeverSubscribed message_retention_days.

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

Builder function that sets the NeverSubscribed message_retention_days.

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

Gets the NeverSubscribed history_public_to_subscribers.

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

Sets the NeverSubscribed history_public_to_subscribers.

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

Unsets the NeverSubscribed history_public_to_subscribers.

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

Builder function that sets the NeverSubscribed history_public_to_subscribers.

pub const fn topics_policy(&self) -> Option<TopicsPolicy>

Gets the NeverSubscribed topics_policy.

pub fn set_topics_policy(&mut self, val: TopicsPolicy)

Sets the NeverSubscribed topics_policy.

pub fn unset_topics_policy(&mut self) -> Option<TopicsPolicy>

Unsets the NeverSubscribed topics_policy.

pub fn with_topics_policy(self, val: TopicsPolicy) -> Self

Builder function that sets the NeverSubscribed topics_policy.

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

Gets the NeverSubscribed first_message_id.

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

Sets the NeverSubscribed first_message_id.

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

Unsets the NeverSubscribed first_message_id.

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

Builder function that sets the NeverSubscribed first_message_id.

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

Gets the NeverSubscribed folder_id.

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

Sets the NeverSubscribed folder_id.

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

Unsets the NeverSubscribed folder_id.

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

Builder function that sets the NeverSubscribed folder_id.

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

Gets the NeverSubscribed is_recently_active.

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

Sets the NeverSubscribed is_recently_active.

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

Unsets the NeverSubscribed is_recently_active.

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

Builder function that sets the NeverSubscribed is_recently_active.

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

Gets the NeverSubscribed is_announcement_only.

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

Sets the NeverSubscribed is_announcement_only.

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

Unsets the NeverSubscribed is_announcement_only.

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

Builder function that sets the NeverSubscribed is_announcement_only.

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

Gets the NeverSubscribed subscriber_count.

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

Sets the NeverSubscribed subscriber_count.

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

Unsets the NeverSubscribed subscriber_count.

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

Builder function that sets the NeverSubscribed subscriber_count.

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

Gets the NeverSubscribed stream_weekly_traffic.

The average number of messages sent to the channel per week, as estimated based on recent weeks, rounded to the nearest integer.

If null, the channel was recently created and there is insufficient data to estimate the average traffic.

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

Sets the NeverSubscribed stream_weekly_traffic.

The average number of messages sent to the channel per week, as estimated based on recent weeks, rounded to the nearest integer.

If null, the channel was recently created and there is insufficient data to estimate the average traffic.

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

Unsets the NeverSubscribed stream_weekly_traffic.

The average number of messages sent to the channel per week, as estimated based on recent weeks, rounded to the nearest integer.

If null, the channel was recently created and there is insufficient data to estimate the average traffic.

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

Builder function that sets the NeverSubscribed stream_weekly_traffic.

The average number of messages sent to the channel per week, as estimated based on recent weeks, rounded to the nearest integer.

If null, the channel was recently created and there is insufficient data to estimate the average traffic.

impl NeverSubscribed

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

Gets the NeverSubscribed name.

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

Sets the NeverSubscribed name.

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

Unsets the NeverSubscribed name.

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

Builder function that sets the NeverSubscribed name.

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

Gets the NeverSubscribed description.

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

Sets the NeverSubscribed description.

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

Unsets the NeverSubscribed description.

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

Builder function that sets the NeverSubscribed description.

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

Gets the NeverSubscribed rendered_description.

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

Sets the NeverSubscribed rendered_description.

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

Unsets the NeverSubscribed rendered_description.

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

Builder function that sets the NeverSubscribed rendered_description.

impl NeverSubscribed

pub fn can_add_subscribers_group(&self) -> Option<&CanAddSubscribersGroup>

Gets the NeverSubscribed can_add_subscribers_group.

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

Sets the NeverSubscribed can_add_subscribers_group.

pub fn unset_can_add_subscribers_group( &mut self, ) -> Option<CanAddSubscribersGroup>

Unsets the NeverSubscribed can_add_subscribers_group.

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

Builder function that sets the NeverSubscribed can_add_subscribers_group.

pub fn can_remove_subscribers_group(&self) -> Option<&CanRemoveSubscribersGroup>

Gets the NeverSubscribed can_remove_subscribers_group.

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

Sets the NeverSubscribed can_remove_subscribers_group.

pub fn unset_can_remove_subscribers_group( &mut self, ) -> Option<CanRemoveSubscribersGroup>

Unsets the NeverSubscribed can_remove_subscribers_group.

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

Builder function that sets the NeverSubscribed can_remove_subscribers_group.

pub fn can_administer_channel_group(&self) -> Option<&CanAdministerChannelGroup>

Gets the NeverSubscribed can_administer_channel_group.

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

Sets the NeverSubscribed can_administer_channel_group.

pub fn unset_can_administer_channel_group( &mut self, ) -> Option<CanAdministerChannelGroup>

Unsets the NeverSubscribed can_administer_channel_group.

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

Builder function that sets the NeverSubscribed can_administer_channel_group.

pub fn can_delete_any_message_group(&self) -> Option<&CanDeleteAnyMessageGroup>

Gets the NeverSubscribed can_delete_any_message_group.

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

Sets the NeverSubscribed can_delete_any_message_group.

pub fn unset_can_delete_any_message_group( &mut self, ) -> Option<CanDeleteAnyMessageGroup>

Unsets the NeverSubscribed can_delete_any_message_group.

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

Builder function that sets the NeverSubscribed can_delete_any_message_group.

pub fn can_delete_own_message_group(&self) -> Option<&CanDeleteOwnMessageGroup>

Gets the NeverSubscribed can_delete_own_message_group.

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

Sets the NeverSubscribed can_delete_own_message_group.

pub fn unset_can_delete_own_message_group( &mut self, ) -> Option<CanDeleteOwnMessageGroup>

Unsets the NeverSubscribed can_delete_own_message_group.

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

Builder function that sets the NeverSubscribed can_delete_own_message_group.

pub fn can_move_messages_out_of_channel_group( &self, ) -> Option<&CanMoveMessagesOutOfChannelGroup>

Gets the NeverSubscribed can_move_messages_out_of_channel_group.

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

Sets the NeverSubscribed can_move_messages_out_of_channel_group.

pub fn unset_can_move_messages_out_of_channel_group( &mut self, ) -> Option<CanMoveMessagesOutOfChannelGroup>

Unsets the NeverSubscribed can_move_messages_out_of_channel_group.

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

Builder function that sets the NeverSubscribed can_move_messages_out_of_channel_group.

pub fn can_move_messages_within_channel_group( &self, ) -> Option<&CanMoveMessagesWithinChannelGroup>

Gets the NeverSubscribed can_move_messages_within_channel_group.

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

Sets the NeverSubscribed can_move_messages_within_channel_group.

pub fn unset_can_move_messages_within_channel_group( &mut self, ) -> Option<CanMoveMessagesWithinChannelGroup>

Unsets the NeverSubscribed can_move_messages_within_channel_group.

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

Builder function that sets the NeverSubscribed can_move_messages_within_channel_group.

pub fn can_send_message_group(&self) -> Option<&CanSendMessageGroup>

Gets the NeverSubscribed can_send_message_group.

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

Sets the NeverSubscribed can_send_message_group.

pub fn unset_can_send_message_group(&mut self) -> Option<CanSendMessageGroup>

Unsets the NeverSubscribed can_send_message_group.

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

Builder function that sets the NeverSubscribed can_send_message_group.

pub fn can_subscribe_group(&self) -> Option<&CanSubscribeGroup>

Gets the NeverSubscribed can_subscribe_group.

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

Sets the NeverSubscribed can_subscribe_group.

pub fn unset_can_subscribe_group(&mut self) -> Option<CanSubscribeGroup>

Unsets the NeverSubscribed can_subscribe_group.

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

Builder function that sets the NeverSubscribed can_subscribe_group.

pub fn can_resolve_topics_group(&self) -> Option<&CanResolveTopicsGroup>

Gets the NeverSubscribed can_resolve_topics_group.

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

Sets the NeverSubscribed can_resolve_topics_group.

pub fn unset_can_resolve_topics_group( &mut self, ) -> Option<CanResolveTopicsGroup>

Unsets the NeverSubscribed can_resolve_topics_group.

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

Builder function that sets the NeverSubscribed can_resolve_topics_group.

impl NeverSubscribed

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

Gets the NeverSubscribed subscribers.

A list of user IDs of users who are subscribed to the channel.

Included only if include_subscribers is true.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

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

Sets the NeverSubscribed subscribers.

A list of user IDs of users who are subscribed to the channel.

Included only if include_subscribers is true.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

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

Unsets the NeverSubscribed subscribers.

A list of user IDs of users who are subscribed to the channel.

Included only if include_subscribers is true.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

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

Builder function that sets the NeverSubscribed subscribers.

A list of user IDs of users who are subscribed to the channel.

Included only if include_subscribers is true.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

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

Gets the NeverSubscribed partial_subscribers.

If include_subscribers=\"partial\" was requested,

the server may, at its discretion, send a partial_subscribers list rather than a subscribers list for channels with a large number of subscribers.

The partial_subscribers list contains an arbitrary subset of the channel’s subscribers that is guaranteed to include all bot user

subscribers as well as all users who have been active in the last 14 days, but otherwise can be chosen arbitrarily by the server.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

Changes: New in Zulip 11.0 (feature level 412).

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

Sets the NeverSubscribed partial_subscribers.

If include_subscribers=\"partial\" was requested,

the server may, at its discretion, send a partial_subscribers list rather than a subscribers list for channels with a large number of subscribers.

The partial_subscribers list contains an arbitrary subset of the channel’s subscribers that is guaranteed to include all bot user

subscribers as well as all users who have been active in the last 14 days, but otherwise can be chosen arbitrarily by the server.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

Changes: New in Zulip 11.0 (feature level 412).

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

Unsets the NeverSubscribed partial_subscribers.

If include_subscribers=\"partial\" was requested,

the server may, at its discretion, send a partial_subscribers list rather than a subscribers list for channels with a large number of subscribers.

The partial_subscribers list contains an arbitrary subset of the channel’s subscribers that is guaranteed to include all bot user

subscribers as well as all users who have been active in the last 14 days, but otherwise can be chosen arbitrarily by the server.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

Changes: New in Zulip 11.0 (feature level 412).

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

Builder function that sets the NeverSubscribed partial_subscribers.

If include_subscribers=\"partial\" was requested,

the server may, at its discretion, send a partial_subscribers list rather than a subscribers list for channels with a large number of subscribers.

The partial_subscribers list contains an arbitrary subset of the channel’s subscribers that is guaranteed to include all bot user

subscribers as well as all users who have been active in the last 14 days, but otherwise can be chosen arbitrarily by the server.

If a user is not allowed to know the subscribers for a channel, we will send an empty array.

API authors should use other data to determine whether users like guest users are forbidden to know the subscribers.

Changes: New in Zulip 11.0 (feature level 412).

Trait Implementations

impl Clone for NeverSubscribed

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 NeverSubscribed

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

Formats the value using the given formatter.

impl Default for NeverSubscribed

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NeverSubscribed

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NeverSubscribed

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

Formats the value using the given formatter.

impl PartialEq for NeverSubscribed

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for NeverSubscribed

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 NeverSubscribed