Struct rustube::Callback

pub struct Callback {
    pub on_progress: OnProgressType,
    pub on_complete: OnCompleteType,
    // some fields omitted
}

This is supported on crate feature callback only.

Methods and streams to process either on_progress or on_complete

Fields

on_progress: OnProgressType

on_complete: OnCompleteType

Implementations

impl Callback

pub fn new() -> Self

This is supported on crate feature stream only.

Create a new callback struct without actual callbacks

pub fn connect_on_progress_closure(
    self,
    closure: impl Fn(CallbackArguments) + 'static
) -> Self

This is supported on crate feature stream only.

Attach a closure to be executed on progress

Warning:

This closure gets executed quite often, once every ~10kB progress. If it’s too slow, some on_progress events will be dropped. If you are looking fore something that will be executed more seldom, look for Callback::connect_on_progress_closure_slow

pub fn connect_on_progress_closure_slow(
    self,
    closure: impl Fn(CallbackArguments) + 'static
) -> Self

This is supported on crate feature stream only.

Attach a closure to be executed on progress. This closure will be executed more seldom, around once for every MB downloaded.

pub fn connect_on_progress_closure_async<Fut: Future<Output = ()> + Send + 'static, F: Fn(CallbackArguments) -> Fut + 'static>(
    self,
    closure: F
) -> Self

This is supported on crate feature stream only.

Attach a async closure to be executed on progress

Warning:

This closure gets executed quite often, once every ~10kB progress. If it’s too slow, some on_progress events will be dropped. If you are looking fore something that will be executed more seldom, look for Callback::connect_on_progress_closure_async_slow

pub fn connect_on_progress_closure_async_slow<Fut: Future<Output = ()> + Send + 'static, F: Fn(CallbackArguments) -> Fut + 'static + Sync + Send>(
    self,
    closure: F
) -> Self

This is supported on crate feature stream only.

Attach a async closure to be executed on progress. This closure will be executed more seldom, around once for every MB downloaded.

pub fn connect_on_progress_sender(
    self,
    sender: Sender<CallbackArguments>,
    cancel_on_close: bool
) -> Self

This is supported on crate feature stream only.

Attach a bounded sender that receives messages on progress cancel_or_close indicates whether or not to cancel the download, if the receiver is closed

Warning:

This sender gets messages quite often, once every ~10kB progress. If it’s too slow, some on_progress events will be dropped.

pub fn connect_on_progress_sender_slow(
    self,
    sender: Sender<CallbackArguments>,
    cancel_on_close: bool
) -> Self

This is supported on crate feature stream only.

Attach a bounded sender that receives messages on progress cancel_or_close indicates whether or not to cancel the download, if the receiver is closed

This closure will be executed more seldom, around once for every MB downloaded.

pub fn connect_on_complete_closure(
    self,
    closure: impl Fn(Option<PathBuf>) + 'static
) -> Self

This is supported on crate feature stream only.

Attach a closure to be executed on complete

pub fn connect_on_complete_closure_async<Fut: Future<Output = ()> + Send + 'static, F: Fn(Option<PathBuf>) -> Fut + 'static>(
    self,
    closure: F
) -> Self

This is supported on crate feature stream only.

Attach a async closure to be executed on complete

Trait Implementations

impl Debug for Callback

This is supported on crate feature stream only.

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

Formats the value using the given formatter.

impl Default for Callback

This is supported on crate feature stream only.

fn default() -> Self

Returns the “default value” for a type.