Struct kuon::ClientBuilder

pub struct ClientBuilder<AccessTokenType, AccessTokenSecretType, ApiKeyType, ApiKeySecretType> { /* fields omitted */ }

A ClientBuilder can help construct a TwitterAPI instance with your configuration. Before calling build method, you must set four values:

1. Access token
2. Access token secret
3. API key
4. API secret key

The four setter methods can be called with any order.

Example

use kuon::ClientBuilder;
let builder = ClientBuilder::new();

// The order of setter methods can be changed.
let api_client = builder
    .access_token("YOUR_ACCESS_TOKEN")
    .access_token_secret("YOUR_ACCESS_TOKEN_SECRET")
    .api_key("YOUR_API_KEY")
    .api_secret_key("YOUR_API_SECRET_KEY")
    .build() // This can be called only after all values have been set.
    .await?;

Implementations

impl ClientBuilder<(), (), (), ()>

pub fn new() -> Self

Creates a builder instance.

This is exactly equivalent to TwitterAPI::builder.

impl ClientBuilder<(), (), String, String>

pub async fn pre_build(&self, callback: Callback) -> Result<OAuthRequestToken>

pub async fn build(
    self,
    request_token: OAuthRequestToken,
    verifier: &str
) -> Result<TwitterAPI>

impl ClientBuilder<String, String, String, String>

pub async fn build(self) -> Result<TwitterAPI>

Builds a TwitterAPI instance with the values you’ve set.

You can call this method only after the four required values have been set.

Error

This method fails if there is an error when obtaining a bearer token.

impl<AccessTokenType, AccessTokenSecretType, ApiKeyType, ApiKeySecretType> ClientBuilder<AccessTokenType, AccessTokenSecretType, ApiKeyType, ApiKeySecretType>

pub fn access_token(
    self,
    access_token: impl Into<String>
) -> ClientBuilder<String, AccessTokenSecretType, ApiKeyType, ApiKeySecretType>

Sets the access token.

pub fn access_token_secret(
    self,
    access_token_secret: impl Into<String>
) -> ClientBuilder<AccessTokenType, String, ApiKeyType, ApiKeySecretType>

Sets the access token secret.

pub fn api_key(
    self,
    api_key: impl Into<String>
) -> ClientBuilder<AccessTokenType, AccessTokenSecretType, String, ApiKeySecretType>

Sets the api key.

pub fn api_secret_key(
    self,
    api_secret_key: impl Into<String>
) -> ClientBuilder<AccessTokenType, AccessTokenSecretType, ApiKeyType, String>

Sets the api secret key.

Trait Implementations

impl<AccessTokenType: Debug, AccessTokenSecretType: Debug, ApiKeyType: Debug, ApiKeySecretType: Debug> Debug for ClientBuilder<AccessTokenType, AccessTokenSecretType, ApiKeyType, ApiKeySecretType>

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

Formats the value using the given formatter.

impl<AccessTokenType: Default, AccessTokenSecretType: Default, ApiKeyType: Default, ApiKeySecretType: Default> Default for ClientBuilder<AccessTokenType, AccessTokenSecretType, ApiKeyType, ApiKeySecretType>

fn default(
) -> ClientBuilder<AccessTokenType, AccessTokenSecretType, ApiKeyType, ApiKeySecretType>

Returns the “default value” for a type.