Struct Request 

pub struct Request { /* private fields */ }

Represents a request to the Fetch API Key Zulip endpoint.

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

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

Implementations

impl Request

pub fn create( algo: Algorithm, key: &EncodingKey, email: &Email, password: &Password, ) -> Result<Self>

Creates a signed JWT token for authenticating the fetch_api_key request.

Parameters

• algo: JWT algorithm set in /etc/zulip/settings.py for the shared secret
• key: JWT shared secret set in /etc/zulip/settings.py

The key argument should be constructed from the shared secret based on the algorithm.

Example

use zulip_api::fetch_api_key::{Email, Password, Request};
use zulip_api::jwt;

// if HMAC-SHA256 (`HS256`) is set in `settings.py`
let algo = jwt::Algorithm::HS256;
let key = jwt::EncodingKey::from_base64_secret("MWFlMTgyZjg3NzM1MzMyYmUxNDEwYWMyM2RlMDRkNzRlOWIwNmI4Mjc2YjQwMmZmYWMzNjllNTA5ZThiN2I0Mg==").unwrap();
let email = Email::new("user@example.dev");
let password = Password::new("super_secret_password");
let _req = Request::create(algo, &key, &email, &password).unwrap();

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

impl Request

pub fn username(&self) -> &str

Gets the Request username.

The username to fetch an API key using the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn set_username(&mut self, val: String)

Sets the Request username.

The username to fetch an API key using the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn with_username(self, val: String) -> Self

Builder function that sets the Request username.

The username to fetch an API key using the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn password(&self) -> &str

Gets the Request password.

The user password to fetch an API key using the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn set_password(&mut self, val: String)

Sets the Request password.

The user password to fetch an API key using the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn with_password(self, val: String) -> Self

Builder function that sets the Request password.

The user password to fetch an API key using the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn token(&self) -> &str

Gets the Request token.

The JWT token used to authenticate the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn set_token(&mut self, val: String)

Sets the Request token.

The JWT token used to authenticate the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

pub fn with_token(self, val: String) -> Self

Builder function that sets the Request token.

The JWT token used to authenticate the fetch_api_key request.

See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#json-web-tokens-jwt.

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<'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

impl Zeroize for Request

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.