Struct Response 

pub struct Response { /* private fields */ }

Represents the response for the Update Message Flags Zulip API endpoint.

See update-message-flags for details.

Implementations

impl Response

pub const fn new() -> Self

Creates a new Response.

impl Response

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

Gets the Response messages.

An array with the IDs of the modified messages.

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

Sets the Response messages.

An array with the IDs of the modified messages.

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

Unsets the Response messages.

An array with the IDs of the modified messages.

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

Builder function that sets the Response messages.

An array with the IDs of the modified messages.

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

Gets the Response ignored_because_not_subscribed_channels.

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

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.

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.

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

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.

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.

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

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.

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.

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

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.

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