Struct Request 

pub struct Request { /* private fields */ }

Represents a message to send to a Zulip server.

Implementations

impl Request

pub const fn new() -> Self

Creates a new Request.

pub const fn queue_id(&self) -> Option<Uuid>

Gets the message queue_id field.

For clients supporting local echo, the event queue ID for the client.

If passed, local_id is required. If the message is successfully sent, the server will include local_id in the message event that the client with this queue_id will receive notifying it of the new message via GET /events. This lets the client know unambiguously that it should replace the locally echoed message, rather than adding this new message (which would be correct if the user had sent the new message from another device).

pub fn set_queue_id<'a, U: Into<Uuid>, S: Into<Cow<'a, str>>>( &mut self, queue_id: U, local_id: S, )

Sets the message queue_id and local_id fields.

If set, the queue_id field requires setting the local_id field.

For clients supporting local echo, the event queue ID for the client.

If passed, local_id is required. If the message is successfully sent, the server will include local_id in the message event that the client with this queue_id will receive notifying it of the new message via GET /events. This lets the client know unambiguously that it should replace the locally echoed message, rather than adding this new message (which would be correct if the user had sent the new message from another device).

pub fn unset_queue_id(&mut self) -> (Option<Uuid>, Option<String>)

Unsets the message queue_id and local_id fields.

If set, the queue_id field requires setting the local_id field.

For clients supporting local echo, the event queue ID for the client.

If passed, local_id is required. If the message is successfully sent, the server will include local_id in the message event that the client with this queue_id will receive notifying it of the new message via GET /events. This lets the client know unambiguously that it should replace the locally echoed message, rather than adding this new message (which would be correct if the user had sent the new message from another device).

pub fn with_queue_id<'a, U: Into<Uuid>, S: Into<Cow<'a, str>>>( self, queue_id: U, local_id: S, ) -> Self

Builder function that sets the message queue_id and local_id fields.

If set, the queue_id field requires setting the local_id field.

For clients supporting local echo, the event queue ID for the client.

If passed, local_id is required. If the message is successfully sent, the server will include local_id in the message event that the client with this queue_id will receive notifying it of the new message via GET /events. This lets the client know unambiguously that it should replace the locally echoed message, rather than adding this new message (which would be correct if the user had sent the new message from another device).

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

Gets the message local_id field.

For clients supporting local echo, a unique string-format identifier chosen freely by the client; the server will pass it back to the client without inspecting it, as described in the queue_id description.

impl Request

pub const fn msg_type(&self) -> MessageType

Gets the Request msg_type.

The type of message to be sent.

"direct" for a direct message and "stream" or "channel" for a

channel message.

Changes: In Zulip 9.0 (feature level 248), "channel" was added as

an additional value for this parameter to request a channel message.

In Zulip 7.0 (feature level 174), "direct" was added as

the preferred way to request a direct message, deprecating the original

"private". While "private" is still supported for requesting direct

messages, clients are encouraged to use to the modern convention with

servers that support it, because support for "private" will eventually

be removed.

pub fn set_msg_type(&mut self, val: MessageType)

Sets the Request msg_type.

The type of message to be sent.

"direct" for a direct message and "stream" or "channel" for a

channel message.

Changes: In Zulip 9.0 (feature level 248), "channel" was added as

an additional value for this parameter to request a channel message.

In Zulip 7.0 (feature level 174), "direct" was added as

the preferred way to request a direct message, deprecating the original

"private". While "private" is still supported for requesting direct

messages, clients are encouraged to use to the modern convention with

servers that support it, because support for "private" will eventually

be removed.

pub fn with_msg_type(self, val: MessageType) -> Self

Builder function that sets the Request msg_type.

The type of message to be sent.

"direct" for a direct message and "stream" or "channel" for a

channel message.

Changes: In Zulip 9.0 (feature level 248), "channel" was added as

an additional value for this parameter to request a channel message.

In Zulip 7.0 (feature level 174), "direct" was added as

the preferred way to request a direct message, deprecating the original

"private". While "private" is still supported for requesting direct

messages, clients are encouraged to use to the modern convention with

servers that support it, because support for "private" will eventually

be removed.

impl Request

pub fn to(&self) -> &MessageTo

Gets the Request to.

For channel messages, either the name or integer ID of the channel. For

direct messages, either a list containing integer user IDs or a list

containing string Zulip API email addresses.

Changes: Support for using user/channel IDs was added in Zulip 2.0.0.

pub fn set_to(&mut self, val: MessageTo)

Sets the Request to.

For channel messages, either the name or integer ID of the channel. For

direct messages, either a list containing integer user IDs or a list

containing string Zulip API email addresses.

Changes: Support for using user/channel IDs was added in Zulip 2.0.0.

pub fn with_to(self, val: MessageTo) -> Self

Builder function that sets the Request to.

For channel messages, either the name or integer ID of the channel. For

direct messages, either a list containing integer user IDs or a list

containing string Zulip API email addresses.

Changes: Support for using user/channel IDs was added in Zulip 2.0.0.

impl Request

pub fn content(&self) -> &str

Gets the Request content.

The content of the message.

Clients should use the max_message_length returned by the

POST /register endpoint to determine

the maximum message size.

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

Sets the Request content.

The content of the message.

Clients should use the max_message_length returned by the

POST /register endpoint to determine

the maximum message size.

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

Builder function that sets the Request content.

The content of the message.

Clients should use the max_message_length returned by the

POST /register endpoint to determine

the maximum message size.

impl Request

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

Gets the Request topic.

The topic of the message.

Only required for channel messages

("type": "stream" or "type": "channel"), ignored otherwise.

Clients should use the max_topic_length returned by the

POST /register endpoint to determine

the maximum topic length.

Note: When "(no topic)" or the value of realm_empty_topic_display_name

found in the POST /register response is used for this

parameter, it is interpreted as an empty string.

When topics are required, this parameter can’t

be "(no topic)", an empty string, or the value of realm_empty_topic_display_name.

Changes: Before Zulip 10.0 (feature level 370), "(no topic)"

was not interpreted as an empty string.

Before Zulip 10.0 (feature level 334), empty string

was not a valid topic name for channel messages.

New in Zulip 2.0.0. Previous Zulip releases encoded

this as subject, which is currently a deprecated alias.

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

Sets the Request topic.

The topic of the message.

Only required for channel messages

("type": "stream" or "type": "channel"), ignored otherwise.

Clients should use the max_topic_length returned by the

POST /register endpoint to determine

the maximum topic length.

Note: When "(no topic)" or the value of realm_empty_topic_display_name

found in the POST /register response is used for this

parameter, it is interpreted as an empty string.

When topics are required, this parameter can’t

be "(no topic)", an empty string, or the value of realm_empty_topic_display_name.

Changes: Before Zulip 10.0 (feature level 370), "(no topic)"

was not interpreted as an empty string.

Before Zulip 10.0 (feature level 334), empty string

was not a valid topic name for channel messages.

New in Zulip 2.0.0. Previous Zulip releases encoded

this as subject, which is currently a deprecated alias.

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

Unsets the Request topic.

The topic of the message.

Only required for channel messages

("type": "stream" or "type": "channel"), ignored otherwise.

Clients should use the max_topic_length returned by the

POST /register endpoint to determine

the maximum topic length.

Note: When "(no topic)" or the value of realm_empty_topic_display_name

found in the POST /register response is used for this

parameter, it is interpreted as an empty string.

When topics are required, this parameter can’t

be "(no topic)", an empty string, or the value of realm_empty_topic_display_name.

Changes: Before Zulip 10.0 (feature level 370), "(no topic)"

was not interpreted as an empty string.

Before Zulip 10.0 (feature level 334), empty string

was not a valid topic name for channel messages.

New in Zulip 2.0.0. Previous Zulip releases encoded

this as subject, which is currently a deprecated alias.

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

Builder function that sets the Request topic.

The topic of the message.

Only required for channel messages

("type": "stream" or "type": "channel"), ignored otherwise.

Clients should use the max_topic_length returned by the

POST /register endpoint to determine

the maximum topic length.

Note: When "(no topic)" or the value of realm_empty_topic_display_name

found in the POST /register response is used for this

parameter, it is interpreted as an empty string.

When topics are required, this parameter can’t

be "(no topic)", an empty string, or the value of realm_empty_topic_display_name.

Changes: Before Zulip 10.0 (feature level 370), "(no topic)"

was not interpreted as an empty string.

Before Zulip 10.0 (feature level 334), empty string

was not a valid topic name for channel messages.

New in Zulip 2.0.0. Previous Zulip releases encoded

this as subject, which is currently a deprecated alias.

impl Request

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

Gets the Request read_by_sender.

Whether the message should be initially marked read by its

sender. If unspecified, the server uses a heuristic based

on the client name.

Changes: New in Zulip 8.0 (feature level 236).

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

Sets the Request read_by_sender.

Whether the message should be initially marked read by its

sender. If unspecified, the server uses a heuristic based

on the client name.

Changes: New in Zulip 8.0 (feature level 236).

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

Unsets the Request read_by_sender.

Whether the message should be initially marked read by its

sender. If unspecified, the server uses a heuristic based

on the client name.

Changes: New in Zulip 8.0 (feature level 236).

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

Builder function that sets the Request read_by_sender.

Whether the message should be initially marked read by its

sender. If unspecified, the server uses a heuristic based

on the client name.

Changes: New in Zulip 8.0 (feature level 236).

Trait Implementations

impl Clone for Request

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 Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Request

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

Formats the value using the given formatter.

impl Eq for Request

impl PartialEq for Request

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Request

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 Request