Struct Response 

pub struct Response { /* private fields */ }

Represents the request for the Update Message Flags for Narrow Zulip API endpoint.

See update-message-flags-for-narrow for details.

Implementations

impl Response

pub const fn new() -> Self

Creates a new Response.

impl Response

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

Gets the Response processed_count.

The number of messages that were within the

update range (at most num_before + 1 + num_after).

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

Sets the Response processed_count.

The number of messages that were within the

update range (at most num_before + 1 + num_after).

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

Unsets the Response processed_count.

The number of messages that were within the

update range (at most num_before + 1 + num_after).

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

Builder function that sets the Response processed_count.

The number of messages that were within the

update range (at most num_before + 1 + num_after).

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

Gets the Response updated_count.

The number of messages where the flag’s

value was changed (at most processed_count).

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

Sets the Response updated_count.

The number of messages where the flag’s

value was changed (at most processed_count).

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

Unsets the Response updated_count.

The number of messages where the flag’s

value was changed (at most processed_count).

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

Builder function that sets the Response updated_count.

The number of messages where the flag’s

value was changed (at most processed_count).

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

Gets the Response first_processed_id.

The ID of the oldest message within the

update range, or null if the range was empty.

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

Sets the Response first_processed_id.

The ID of the oldest message within the

update range, or null if the range was empty.

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

Unsets the Response first_processed_id.

The ID of the oldest message within the

update range, or null if the range was empty.

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

Builder function that sets the Response first_processed_id.

The ID of the oldest message within the

update range, or null if the range was empty.

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

Gets the Response last_processed_id.

The ID of the newest message within the

update range, or null if the range was empty.

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

Sets the Response last_processed_id.

The ID of the newest message within the

update range, or null if the range was empty.

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

Unsets the Response last_processed_id.

The ID of the newest message within the

update range, or null if the range was empty.

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

Builder function that sets the Response last_processed_id.

The ID of the newest message within the

update range, or null if the range was empty.

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

Gets the Response found_oldest.

Whether the update range reached backward

far enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

first_processed_id).

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

Sets the Response found_oldest.

Whether the update range reached backward

far enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

first_processed_id).

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

Unsets the Response found_oldest.

Whether the update range reached backward

far enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

first_processed_id).

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

Builder function that sets the Response found_oldest.

Whether the update range reached backward

far enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

first_processed_id).

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

Gets the Response found_newest.

Whether the update range reached forward far

enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

last_processed_id).

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

Sets the Response found_newest.

Whether the update range reached forward far

enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

last_processed_id).

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

Unsets the Response found_newest.

Whether the update range reached forward far

enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

last_processed_id).

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

Builder function that sets the Response found_newest.

Whether the update range reached forward far

enough to include very oldest message

matching the narrow (used by clients doing a

bulk update to decide whether to issue

another request anchored at

last_processed_id).

impl Response

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

Gets the Response ignored_because_not_subscribed_channels.

Zulip has an invariant that all unread messages must be in channels

the user is subscribed to. This field will contain a list of the

channels whose messages were skipped to mark as unread because the

user is not subscribed to them.

Only present if the flag is read and the operation is remove.

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

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

Sets the Response ignored_because_not_subscribed_channels.

Zulip has an invariant that all unread messages must be in channels

the user is subscribed to. This field will contain a list of the

channels whose messages were skipped to mark as unread because the

user is not subscribed to them.

Only present if the flag is read and the operation is remove.

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

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

Unsets the Response ignored_because_not_subscribed_channels.

Zulip has an invariant that all unread messages must be in channels

the user is subscribed to. This field will contain a list of the

channels whose messages were skipped to mark as unread because the

user is not subscribed to them.

Only present if the flag is read and the operation is remove.

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

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

Builder function that sets the Response ignored_because_not_subscribed_channels.

Zulip has an invariant that all unread messages must be in channels

the user is subscribed to. This field will contain a list of the

channels whose messages were skipped to mark as unread because the

user is not subscribed to them.

Only present if the flag is read and the operation is remove.

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

Trait Implementations

impl Clone for Response

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 Response

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

Formats the value using the given formatter.

impl Default for Response

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Response

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Response

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

Formats the value using the given formatter.

impl Eq for Response

impl PartialEq for Response

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

Equality operator ==.

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

Inequality operator !=.

impl Response for Response

fn msg(&self) -> &str

Gets the Response msg field.

fn set_msg<'a, C: Into<Cow<'a, str>>>(&mut self, msg: C)

Sets the Response msg field.

fn with_msg<'a, C: Into<Cow<'a, str>>>(self, msg: C) -> Self

Builder function that sets the Response msg field.

fn result(&self) -> ApiResult

Gets the Response result field.

fn set_result(&mut self, result: ApiResult)

Sets the Response result field.

fn with_result(self, result: ApiResult) -> Self

Builder function that sets the Response result field.

fn code(&self) -> Option<ErrorCode>

Gets the Response code field.

fn set_code(&mut self, code: ErrorCode)

Sets the Response code field.

fn unset_code(&mut self) -> Option<ErrorCode>

Unsets the Response code field.

fn with_code(self, code: ErrorCode) -> Self

Builder function that sets the Response code field.

fn ignored_parameters_unsupported(&self) -> Option<&[String]>

Gets the Response ignored unsupported parameters list.

fn set_ignored_parameters_unsupported<'a, C: Into<Cow<'a, [String]>>>( &mut self, val: C, )

Sets the Response ignored unsupported parameters list.

fn unset_ignored_parameters_unsupported(&mut self) -> Option<Vec<String>>

Unsets the Response ignored unsupported parameters list.

fn with_ignored_parameters_unsupported<'a, C: Into<Cow<'a, [String]>>>( self, val: C, ) -> Self

Builder function that sets the Response ignored unsupported parameters list.

impl Serialize for Response

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 Response