Struct ClientConfigBuilder

pub struct ClientConfigBuilder { /* private fields */ }

Builder for ClientConfig.

Implementations

impl ClientConfigBuilder

pub fn timeout(&mut self, value: Option<Duration>) -> &mut Self

Connection timeout for control requests.

pub fn transfer_timeout(&mut self, value: Option<Duration>) -> &mut Self

Connection timeout specific to file transfers.

pub fn basic_auth( &mut self, value: Option<(String, Option<String>)>, ) -> &mut Self

Basic HTTP authentication credentials.

Consists of a username, and an optional password.

pub fn build(&self) -> Result<ClientConfig, String>

Builds a new ClientConfig.

Errors

If a required field has not been initialized.

Examples found in repository

examples/upload.rs (line 20)

fn upload_file(path: PathBuf) -> Result<RemoteFile, Error> {
    // Build the client for uploading
    let client_config = ClientConfigBuilder::default().build().unwrap();
    let client = client_config.client(true);

    #[cfg(feature = "send3")]
    let version = Version::V3;
    #[cfg(not(feature = "send3"))]
    let version = Version::V2;

    // Build upload action, and invoke to upload
    let upload = Upload::new(
        version,
        Url::parse("https://send.firefox.com/").unwrap(),
        path,
        None,
        None,
        None,
    );
    Upload::invoke(upload, &client, None)
}

Trait Implementations

impl Clone for ClientConfigBuilder

fn clone(&self) -> ClientConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ClientConfigBuilder

fn default() -> ClientConfigBuilder

Returns the “default value” for a type.