Struct utapi_rs::config::UploadthingConfig

pub struct UploadthingConfig {
    pub host: String,
    pub user_agent: Option<String>,
    pub api_key: Option<ApiKey>,
    pub version: Option<String>,
}

Configuration for the Uploadthing service.

This struct contains all the necessary configurations required to interact with the Uploadthing API. It includes the host URL, optional user agent, API key, and version information.

Fields

host: String

The host URL of the Uploadthing service.

user_agent: Option<String>

An optional user agent string to be sent with each request. This can be used for identifying the client to the server.

api_key: Option<ApiKey>

An optional API key for authentication with the Uploadthing service. If provided, it will be included in the headers of each request.

version: Option<String>

An optional version string to be sent with each request. This can represent the version of the client application.

Implementations

impl UploadthingConfig

pub fn new() -> UploadthingConfig

Creates a new UploadthingConfig with default values.

This is a convenience method that calls UploadthingConfig::default() to create a new configuration instance with the default host, user agent, and version values. The API key is not set by default.

Examples

let config = UploadthingConfig::new();
// The `config` now contains the default settings.

pub fn builder() -> UploadthingConfigBuilder

Creates a builder for UploadthingConfig.

This method returns an instance of UploadthingConfigBuilder which can be used to set various configuration options before building the final UploadthingConfig instance.

Examples

let builder = UploadthingConfig::builder();
let config = builder.host("https://customhost.com")
                    .user_agent("CustomUserAgent/1.0")
                    .api_key("my_api_key")
                    .version("1.0.0")
                    .build();
// The `config` is now customized with the provided settings.

Trait Implementations

impl Clone for UploadthingConfig

fn clone(&self) -> UploadthingConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UploadthingConfig

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

Formats the value using the given formatter.

impl Default for UploadthingConfig

fn default() -> UploadthingConfig

Provides default values for UploadthingConfig.

This implementation sets default values for the host, user agent, and version. The default host is set to “https://uploadthing.com”. The user agent is constructed using the crate version and the name “utapi-rs”. The version is set to the crate’s current version. The API key is attempted to be retrieved from the environment variable UPLOADTHING_SECRET. If the environment variable is not set, the API key will be None.

Returns

Returns an UploadthingConfig instance with default values set.

Examples

let default_config = UploadthingConfig::default();
assert_eq!(default_config.host, "https://uploadthing.com");
// Other fields are set to their respective defaults

impl<'de> Deserialize<'de> for UploadthingConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UploadthingConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.