How to use progress method of com.github.kittinunf.fuel.core.requests.UploadRequest class

...19    /**20     * Add a [ProgressCallback] tracking the [Body] of the [Request]21     *22     * @see body23     * @see com.github.kittinunf.fuel.core.requests.UploadRequest.progress24     *25     * @return self26     */27    fun requestProgress(handler: ProgressCallback): Request28    /**29     * Add a [ProgressCallback] tracking the [Body] of the [Response]30     *31     * @see com.github.kittinunf.fuel.core.requests.DownloadRequest.progress32     *33     * @return self34     */35    fun responseProgress(handler: ProgressCallback): Request36    /**37     * Overwrite the [Request] [timeout] in milliseconds38     *39     * @note [Client] must implement this behaviour40     * @note the default client sets [java.net.HttpURLConnection.setConnectTimeout]41     *42     * @param timeout [Int] timeout in milliseconds43     * @return self44     */45    fun timeout(timeout: Int): Request...

...267    /**268     * Add a [ProgressCallback] tracking the [Body] of the [Request]269     *270     * @see body271     * @see com.github.kittinunf.fuel.core.requests.UploadRequest.progress272     *273     * @return self274     */275    override fun requestProgress(handler: ProgressCallback): Request {276        executionOptions.requestProgress += handler277        return request278    }279    /**280     * Add a [ProgressCallback] tracking the [Body] of the [com.github.kittinunf.fuel.core.Response]281     *282     * @see com.github.kittinunf.fuel.core.requests.DownloadRequest.progress283     *284     * @return self285     */286    override fun responseProgress(handler: ProgressCallback): Request {287        executionOptions.responseProgress += handler288        return request289    }290    /**291     * Add a [InterruptCallback] to the [RequestExecutionOptions]292     *293     * @see RequestExecutionOptions.interruptCallbacks294     *295     * @return self296     */...

...27    var proxy: Proxy? = null28    var basePath: String? = null29    var timeoutInMillisecond: Int = 15_00030    var timeoutReadInMillisecond: Int = timeoutInMillisecond31    var progressBufferSize: Int = DEFAULT_BUFFER_SIZE32    var hook: Hook = DefaultHook()33    var baseHeaders: Map<String, String>? = null34    var baseParams: Parameters = emptyList()35    var keystore: KeyStore? = null36    var socketFactory: SSLSocketFactory by readWriteLazy {37        keystore?.let {38            val trustFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm())39            trustFactory.init(it)40            val sslContext = SSLContext.getInstance("SSL")41            sslContext.init(null, trustFactory.trustManagers, null)42            sslContext.socketFactory43        } ?: HttpsURLConnection.getDefaultSSLSocketFactory()44    }45    var hostnameVerifier: HostnameVerifier by readWriteLazy {46        HttpsURLConnection.getDefaultHostnameVerifier()47    }48    // background executionOptions49    var executorService: ExecutorService by readWriteLazy {50        Executors.newCachedThreadPool { command ->51            Thread(command).also { thread ->52                thread.priority = Thread.NORM_PRIORITY53                thread.isDaemon = true54            }55        }56    }57    private val requestInterceptors: MutableList<FoldableRequestInterceptor> =58            mutableListOf(ParameterEncoder)59    private val responseInterceptors: MutableList<FoldableResponseInterceptor> =60            mutableListOf(redirectResponseInterceptor(this))61    // callback executionOptions62    var callbackExecutor: Executor by readWriteLazy { createEnvironment().callbackExecutor }63    var forceMethods: Boolean = false64    /**65     * Make a request using [method] to [path] with [parameters]66     *67     * @see FuelManager.instance68     * @see FuelManager.applyOptions69     *70     * @param method [Method] the HTTP method to make the request with71     * @param path [String] the absolute url or relative to [FuelManager.instance] basePath72     * @param parameters [Parameters?] list of parameters73     *74     * @return [Request] the request75     */76    override fun request(method: Method, path: String, parameters: Parameters?): Request {77        val request = request(Encoding(78            httpMethod = method,79            urlString = path,80            baseUrlString = basePath,81            parameters = if (parameters == null) baseParams else baseParams + parameters82        ).request)83        return applyOptions(request)84    }85    /**86     * Make a request using [method] to [convertible]'s path with [parameters]87     *88     * @see FuelManager.instance89     * @see RequestFactory(Method, String, Parameters?)90     *91     * @param method [Method] the HTTP method to make the request with92     * @param convertible [PathStringConvertible]93     * @param parameters [Parameters?] list of parameters94     *95     * @return [Request] the request96     */97    override fun request(method: Method, convertible: PathStringConvertible, parameters: Parameters?): Request =98        request(method, convertible.path, parameters)99    /**100     * Make a request using from [convertible]101     *102     * @param convertible [RequestConvertible] the instance that can be turned into a [Request]103     * @return [Request] the request104     */105    override fun request(convertible: RequestConvertible): Request = applyOptions(convertible.request)106    /**107     * Create a [method] [Request] to [path] with [parameters], which can download to a file108     *109     * @param path [String] the absolute or relative to [FuelManager.instance]' base-path path110     * @param method [Method] the method to download with, defaults to [Method.GET]111     * @param parameters [Parameters] the optional parameters112     * @return [DownloadRequest] the request (extended for download)113     */114    override fun download(path: String, method: Method, parameters: Parameters?): DownloadRequest {115        val request = Encoding(116            httpMethod = method,117            urlString = path,118            baseUrlString = basePath,119            parameters = if (parameters == null) baseParams else baseParams + parameters120        ).request121        return applyOptions(request).download()122    }123    /**124     * Create a [method] [Request] to [path] with [parameters], which can upload blobs and Data Parts125     *126     * @param path [String] the absolute or relative to [FuelManager.instance]' base-path path127     * @param method [Method] the method to upload with, defaults to [Method.POST]128     * @param parameters [Parameters] the optional parameters129     * @return [UploadRequest] the request (extended for upload)130     */131    override fun upload(path: String, method: Method, parameters: Parameters?): UploadRequest {132        val request = Encoding(133            httpMethod = method,134            urlString = path,135            baseUrlString = basePath,136            parameters = if (parameters == null) baseParams else baseParams + parameters137        ).request138        return applyOptions(request).upload()139    }140    fun addRequestInterceptor(interceptor: FoldableRequestInterceptor): FuelManager {141        requestInterceptors += interceptor142        return this143    }144    fun addResponseInterceptor(interceptor: FoldableResponseInterceptor): FuelManager {145        responseInterceptors += interceptor146        return this147    }148    fun removeRequestInterceptor(interceptor: FoldableRequestInterceptor): FuelManager {149        requestInterceptors -= interceptor150        return this151    }152    fun removeResponseInterceptor(interceptor: FoldableResponseInterceptor): FuelManager {153        responseInterceptors -= interceptor154        return this155    }156    fun removeAllRequestInterceptors(): FuelManager {157        requestInterceptors.clear()158        return this159    }160    fun removeAllResponseInterceptors(): FuelManager {161        responseInterceptors.clear()162        return this163    }164    private fun applyOptions(request: Request): Request {165        // Sets base headers ONLY if they are not set166        val unsetBaseHeaders = request.headers.keys.fold(Headers.from(baseHeaders.orEmpty())) {167            result, it -> result.remove(it); result168        }169        return request.header(unsetBaseHeaders).apply {170            executionOptions = RequestExecutionOptions(171                client = client,172                socketFactory = socketFactory,173                hostnameVerifier = hostnameVerifier,174                callbackExecutor = callbackExecutor,175                requestTransformer = requestInterceptors.foldRight({ r: Request -> r }) { f, acc -> f(acc) },176                responseTransformer = responseInterceptors.foldRight({ _: Request, res: Response -> res }) { f, acc -> f(acc) },177                executorService = executorService178            ).also { executor ->179                executor.timeoutInMillisecond = timeoutInMillisecond180                executor.timeoutReadInMillisecond = timeoutReadInMillisecond181                executor.forceMethods = forceMethods182            }183        }184    }185    companion object {186        // manager187        var instance by readWriteLazy { FuelManager() }188        val progressBufferSize: Int get() = instance.progressBufferSize189    }190    /**191     * Create a [Method.GET] [Request] to [path] with [parameters]192     *193     * @param path [String] the absolute or relative to [FuelManager.instance]' base-path path194     * @param parameters [Parameters] the optional parameters195     * @return [Request] the request196     */197    override fun get(path: String, parameters: Parameters?): Request =198        request(Method.GET, path, parameters)199    /**200     * Create a [Method.GET] [Request] to [PathStringConvertible.path] with [parameters]201     *202     * @param convertible [PathStringConvertible] the absolute or relative to [FuelManager.instance]' base-path path...

...58        acc.plus(dataPart)59    }60    /**61     * Add a [ProgressCallback] to the [requestProgress]62     * @param progress [ProgressCallback] the callback63     */64    fun progress(progress: ProgressCallback) = requestProgress(progress)65    companion object {66        val FEATURE: String = UploadRequest::class.java.canonicalName67        /**68         * Enable [UploadRequest] for the passed in [request]69         *70         * @note this sets the Content-Type to multipart/form-data; boundary=uuid even when there was already a71         *   Content-Type set, unless it's multipart/form-data with a valid boundary.72         *73         * @param request [Request] the request to enable this for74         * @return [UploadRequest] the enhanced request75         */76        fun enableFor(request: Request) = request.enabledFeatures77            .getOrPut(FEATURE) {78                UploadRequest(request)...

1    println("We are currently in the progress $readBytes out of $totalBytes")2}.source { request, url ->3    FileInputStream(File("path/to/file"))4}.responseString()5    println("We are currently in the progress $readBytes out of $totalBytes")6}.fileDestination { response, url ->7    File.createTempFile("image", "png")8}.responseString()9    println("We are currently in the progress $readBytes out of $totalBytes")10}.destination { response, url ->11    { bytes ->12    }13}.responseString()

1import com.github.kittinunf.fuel.core.requests.UploadRequest2import com.github.kittinunf.fuel.core.requests.upload3import java.io.File4val file = File("my_file.txt")5    .add(file)6    .progress { readBytes, totalBytes ->7        println("Uploaded $readBytes out of $totalBytes")8    }9    .response()10import com.github.kittinunf.fuel.core.requests.DownloadRequest11import com.github.kittinunf.fuel.core.requests.download12import java.io.File13val file = File("my_file.txt")14    .fileDestination { _, _ -> file }15    .progress { readBytes, totalBytes ->16        println("Downloaded $readBytes out of $totalBytes")17    }18    .response()19import com.github.kittinunf.fuel.core.requests.DownloadRequest20import com.github.kittinunf.fuel.core.requests.download21import java.io.File22import android.os.Handler23import android.os.Looper24val file = File("my_file.txt")25val handler = Handler(Looper.getMainLooper())26    .fileDestination { _, _ -> file }27    .progress { readBytes, totalBytes ->28        handler.post {29            println("Downloaded $readBytes out of $totalBytes")30        }31    }32    .response()