Struct Response 

pub struct Response { /* private fields */ }

Represents a response from the Fetch API Key Zulip endpoint.

Allows third-party applications to use a username-password authentication method.

Implementations

impl Response

pub const fn new() -> Self

Creates a new Self.

impl Response

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

Gets the Response api_key.

The API key that can be used to authenticate as the requested user.

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

Sets the Response api_key.

The API key that can be used to authenticate as the requested user.

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

Unsets the Response api_key.

The API key that can be used to authenticate as the requested user.

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

Builder function that sets the Response api_key.

The API key that can be used to authenticate as the requested user.

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

Gets the Response email.

The email address of the user who owns the API key.

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

Sets the Response email.

The email address of the user who owns the API key.

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

Unsets the Response email.

The email address of the user who owns the API key.

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

Builder function that sets the Response email.

The email address of the user who owns the API key.

impl Response

pub const fn user_id(&self) -> Option<i64>

Gets the Response user_id.

The unique ID of the user who owns the API key.

Changes: New in Zulip 7.0 (feature level 171).

pub fn set_user_id(&mut self, val: i64)

Sets the Response user_id.

The unique ID of the user who owns the API key.

Changes: New in Zulip 7.0 (feature level 171).

pub fn unset_user_id(&mut self) -> Option<i64>

Unsets the Response user_id.

The unique ID of the user who owns the API key.

Changes: New in Zulip 7.0 (feature level 171).

pub fn with_user_id(self, val: i64) -> Self

Builder function that sets the Response user_id.

The unique ID of the user who owns the API key.

Changes: New in Zulip 7.0 (feature level 171).

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

impl Zeroize for Response

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.