Struct utapi_rs::config::UploadthingConfigBuilder

pub struct UploadthingConfigBuilder { /* private fields */ }

A builder for UploadthingConfig.

This builder allows for a fluent interface to construct a UploadthingConfig instance with custom values. It starts with default values and allows the user to set properties such as host, user agent, API key, and version before building the final configuration object.

Implementations

impl UploadthingConfigBuilder

pub fn new() -> Self

Creates a new UploadthingConfigBuilder with default configuration values.

This uses UploadthingConfig::default() to initialize the internal config with default values.

pub fn host(self, host: &str) -> Self

Sets the host URL in the configuration.

Arguments

• host - A string slice that holds the URL of the Uploadthing service.

Examples

let builder = UploadthingConfigBuilder::new().host("https://example.com");

pub fn user_agent(self, user_agent: &str) -> Self

Sets the user agent in the configuration.

Arguments

• user_agent - A string slice that represents the user agent to be sent with each request.

Examples

let builder = UploadthingConfigBuilder::new().user_agent("MyUploader/1.0");

pub fn api_key(self, api_key: &str) -> Self

Sets the API key in the configuration.

This method allows the user to provide an API key as a string slice that will be used for authenticating with the Uploadthing service. It attempts to parse the provided string into an ApiKey instance using the FromStr trait implementation for ApiKey. If parsing is successful, the ApiKey is wrapped in a Some and set in the configuration. If parsing fails, it falls back to the default ApiKey which is obtained from the environment variable UPLOADTHING_SECRET.

Arguments

• api_key - A string slice that represents the API key for authenticating with the service.

Examples

let builder = UploadthingConfigBuilder::new().api_key("your_api_key");

Panics

This method will panic if the provided api_key string is not in a valid format and there is no UPLOADTHING_SECRET environment variable set to fall back on.

pub fn version(self, version: &str) -> Self

Sets the version in the configuration.

Arguments

• version - A string slice that represents the version of the client application.

Examples

let builder = UploadthingConfigBuilder::new().version("2.0.0");

pub fn build(self) -> UploadthingConfig

Builds the UploadthingConfig with the current settings of the builder.

Consumes the builder and returns the configured UploadthingConfig instance.

Examples

let config = UploadthingConfigBuilder::new()
    .host("https://example.com")
    .user_agent("MyUploader/1.0")
    .api_key("your_api_key")
    .version("2.0.0")
    .build();

Trait Implementations

impl Default for UploadthingConfigBuilder

Implements the Default trait for UploadthingConfigBuilder.

This allows for the creation of a builder with the default configuration by calling UploadthingConfigBuilder::default().

fn default() -> Self

Returns a new UploadthingConfigBuilder initialized with default values.