Struct CloudConvertClient 

pub struct CloudConvertClient { /* private fields */ }

Entry point for authenticated CloudConvert API calls and file transfer.

Implementations

impl CloudConvertClient

pub fn builder(api_key: ApiKey) -> ClientBuilder

Starts a client builder authenticated with an API key.

pub fn builder_with_access_token( access_token: OAuthAccessToken, ) -> ClientBuilder

Starts a client builder authenticated with an OAuth access token.

pub fn config(&self) -> &CloudConvertConfig

Returns the resolved client configuration, including base URLs and region.

pub fn jobs(&self) -> JobsResource

Job lifecycle endpoints: create, wait, list, and delete.

pub fn tasks(&self) -> TasksResource

Standalone task endpoints outside a job graph.

pub fn users(&self) -> UsersResource

Account endpoints and user-scoped Socket.IO subscriptions.

pub fn webhooks(&self) -> WebhooksResource

Webhook registration and listing for the authenticated account.

pub fn operations(&self) -> OperationsResource

CloudConvert operations metadata used to discover engines and options.

pub fn socket_base_url(&self) -> &'static str

Socket.IO base URL for the client’s sandbox or production environment.

pub fn socket_subscription(&self, channel: SocketChannel) -> SocketSubscription

Builds a bearer-authenticated subscription payload for a Socket.IO channel.

pub async fn download(&self, url: impl AsRef<str>) -> Result<Bytes>

Downloads a URL, typically an export file link, into memory.

pub async fn download_stream( &self, url: impl AsRef<str>, ) -> Result<impl Stream<Item = Result<Bytes>>>

Streams a download without buffering the full response in memory.

pub async fn download_to_path( &self, url: impl AsRef<str>, destination: impl AsRef<Path>, ) -> Result<()>

Streams a download to destination through a sibling temporary file.

The destination is replaced atomically on success; the temp file is removed if the download or rename fails.

pub async fn upload_bytes( &self, task: &Task, filename: impl Into<String>, bytes: impl Into<Bytes>, ) -> Result<()>

Uploads bytes to an import/upload task using its presigned form.

Returns Error::UploadTaskNotReady when the task has no upload form yet.

pub async fn upload_body( &self, task: &Task, filename: impl Into<String>, body: Body, ) -> Result<()>

pub async fn upload_stream<S, B, E>( &self, task: &Task, filename: impl Into<String>, stream: S, ) -> Result<()>

where S: TryStream<Ok = B, Error = E> + Send + 'static, Bytes: From<B>, E: Into<Box<dyn StdError + Send + Sync>>,

pub async fn upload_path( &self, task: &Task, path: impl AsRef<Path>, ) -> Result<()>

Trait Implementations

impl Clone for CloudConvertClient

fn clone(&self) -> CloudConvertClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloudConvertClient

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

Formats the value using the given formatter.