Struct Request 

pub struct Request { /* 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 Request

pub const fn new() -> Self

Creates a new Request.

impl Request

pub const fn anchor(&self) -> Anchor

Gets the Request anchor.

Represents an anchor updating of flags.

Either an integer message ID, or a special string values for when

the client wants the server to compute the anchor to use.

pub fn set_anchor(&mut self, val: Anchor)

Sets the Request anchor.

Represents an anchor updating of flags.

Either an integer message ID, or a special string values for when

the client wants the server to compute the anchor to use.

pub fn with_anchor(self, val: Anchor) -> Self

Builder function that sets the Request anchor.

Represents an anchor updating of flags.

Either an integer message ID, or a special string values for when

the client wants the server to compute the anchor to use.

pub const fn num_before(&self) -> u64

Gets the Request num_before.

Limit the number of messages preceding the anchor in the update range.

The server may decrease this to bound transaction sizes.

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

Sets the Request num_before.

Limit the number of messages preceding the anchor in the update range.

The server may decrease this to bound transaction sizes.

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

Builder function that sets the Request num_before.

Limit the number of messages preceding the anchor in the update range.

The server may decrease this to bound transaction sizes.

pub const fn num_after(&self) -> u64

Gets the Request num_after.

Limit the number of messages following the anchor in the update range.

The server may decrease this to bound transaction sizes.

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

Sets the Request num_after.

Limit the number of messages following the anchor in the update range.

The server may decrease this to bound transaction sizes.

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

Builder function that sets the Request num_after.

Limit the number of messages following the anchor in the update range.

The server may decrease this to bound transaction sizes.

pub const fn op(&self) -> Operation

Gets the Request op.

Whether to add the flag or remove it.

pub fn set_op(&mut self, val: Operation)

Sets the Request op.

Whether to add the flag or remove it.

pub fn with_op(self, val: Operation) -> Self

Builder function that sets the Request op.

Whether to add the flag or remove it.

pub const fn flag(&self) -> Flag

Gets the Request flag.

The flag that should be added/removed.

See available flags.

pub fn set_flag(&mut self, val: Flag)

Sets the Request flag.

The flag that should be added/removed.

See available flags.

pub fn with_flag(self, val: Flag) -> Self

Builder function that sets the Request flag.

The flag that should be added/removed.

See available flags.

impl Request

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

Gets the Request include_anchor.

Whether a message with the specified ID matching the narrow

should be included in the update range.

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

Sets the Request include_anchor.

Whether a message with the specified ID matching the narrow

should be included in the update range.

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

Unsets the Request include_anchor.

Whether a message with the specified ID matching the narrow

should be included in the update range.

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

Builder function that sets the Request include_anchor.

Whether a message with the specified ID matching the narrow

should be included in the update range.

impl Request

pub fn narrow(&self) -> &[Narrow]

Gets the Request narrow.

The narrow you want update flags within. See how to

construct a narrow.

Note that, when adding the read flag to messages, clients should

consider including a narrow with the is:unread filter as an

optimization. Including that filter takes advantage of the fact that

the server has a database index for unread messages.

Changes: See changes section

of search/narrow filter documentation.

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

Sets the Request narrow.

The narrow you want update flags within. See how to

construct a narrow.

Note that, when adding the read flag to messages, clients should

consider including a narrow with the is:unread filter as an

optimization. Including that filter takes advantage of the fact that

the server has a database index for unread messages.

Changes: See changes section

of search/narrow filter documentation.

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

Builder function that sets the Request narrow.

The narrow you want update flags within. See how to

construct a narrow.

Note that, when adding the read flag to messages, clients should

consider including a narrow with the is:unread filter as an

optimization. Including that filter takes advantage of the fact that

the server has a database index for unread messages.

Changes: See changes section

of search/narrow filter documentation.

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