Skip to main content

UnreadMsgsStream

Struct UnreadMsgsStream 

Source
pub struct UnreadMsgsStream { /* private fields */ }
Expand description

Represents details of all unread messages of a single subscribed channel.

This includes muted channels and muted topics, even though those messages are excluded from count. Changes: Prior to Zulip 5.0 (feature level 90), these objects included a sender_ids property, which listed the set of IDs of users who had sent the unread messages.

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§

Source§

impl UnreadMsgsStream

Source

pub const fn new() -> Self

Creates a new UnreadMsgsStream.

Source§

impl UnreadMsgsStream

Source

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

Gets the UnreadMsgsStream topic.

The topic under which the messages were sent.

Note that the empty string topic may have been rewritten by the server to the value of realm_empty_topic_display_name found in the

POST /register response depending on the value of the empty_topic_name

client capability.

Changes: The empty_topic_name client capability is new in Zulip 10.0 (feature level 334).

Source

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

Sets the UnreadMsgsStream topic.

The topic under which the messages were sent.

Note that the empty string topic may have been rewritten by the server to the value of realm_empty_topic_display_name found in the

POST /register response depending on the value of the empty_topic_name

client capability.

Changes: The empty_topic_name client capability is new in Zulip 10.0 (feature level 334).

Source

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

Unsets the UnreadMsgsStream topic.

The topic under which the messages were sent.

Note that the empty string topic may have been rewritten by the server to the value of realm_empty_topic_display_name found in the

POST /register response depending on the value of the empty_topic_name

client capability.

Changes: The empty_topic_name client capability is new in Zulip 10.0 (feature level 334).

Source

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

Builder function that sets the UnreadMsgsStream topic.

The topic under which the messages were sent.

Note that the empty string topic may have been rewritten by the server to the value of realm_empty_topic_display_name found in the

POST /register response depending on the value of the empty_topic_name

client capability.

Changes: The empty_topic_name client capability is new in Zulip 10.0 (feature level 334).

Source

pub fn unread_message_ids(&self) -> Option<&[i32]>

Gets the UnreadMsgsStream unread_message_ids.

The message IDs of the recent unread messages sent in this channel, sorted in ascending order.

Source

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

Sets the UnreadMsgsStream unread_message_ids.

The message IDs of the recent unread messages sent in this channel, sorted in ascending order.

Source

pub fn unset_unread_message_ids(&mut self) -> Option<Vec<i32>>

Unsets the UnreadMsgsStream unread_message_ids.

The message IDs of the recent unread messages sent in this channel, sorted in ascending order.

Source

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

Builder function that sets the UnreadMsgsStream unread_message_ids.

The message IDs of the recent unread messages sent in this channel, sorted in ascending order.

Source§

impl UnreadMsgsStream

Source

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

Gets the UnreadMsgsStream stream_id.

The ID of the channel to which the messages were sent.

Source

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

Sets the UnreadMsgsStream stream_id.

The ID of the channel to which the messages were sent.

Source

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

Unsets the UnreadMsgsStream stream_id.

The ID of the channel to which the messages were sent.

Source

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

Builder function that sets the UnreadMsgsStream stream_id.

The ID of the channel to which the messages were sent.

Trait Implementations§

Source§

impl Clone for UnreadMsgsStream

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnreadMsgsStream

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UnreadMsgsStream

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for UnreadMsgsStream

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for UnreadMsgsStream

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for UnreadMsgsStream

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for UnreadMsgsStream

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for UnreadMsgsStream

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more