Skip to main content

BlockingEngine

Struct BlockingEngine 

Source
pub struct BlockingEngine { /* private fields */ }
Expand description

Synchronous facade for callers that do not want to own a Tokio runtime. The async engine remains the single implementation.

Implementations§

Source§

impl BlockingEngine

Source

pub fn new( router: Router, store: Arc<dyn TaskStore>, config: Config, ) -> Result<Self>

Creates an engine backed by a dedicated multi-threaded Tokio runtime.

Source

pub fn engine(&self) -> &DownloadEngine

Returns a reference to the underlying asynchronous engine.

Source

pub fn subscribe(&self) -> Receiver<DownloadEvent>

Subscribes to engine events, delivered over a standard library channel.

Source

pub fn download( &self, link: Link, destination: PathBuf, options: TaskOptions, ) -> Result<Task>

Adds a task and runs it to completion, blocking the current thread.

Source

pub fn add( &self, link: Link, destination: PathBuf, options: TaskOptions, ) -> Result<Task>

Registers a task without running it.

Source

pub fn run_task(&self, id: TaskId) -> Result<Task>

Blocks until the given task finishes and returns its final state.

Source

pub fn list(&self) -> Result<Vec<Task>>

Lists all stored tasks.

Source

pub fn status(&self, id: TaskId) -> Result<Task>

Loads a single task by id.

Source

pub fn pause(&self, id: TaskId) -> Result<Task>

Marks a task paused and cancels its in-flight transfer.

Source

pub fn resume(&self, id: TaskId) -> Result<Task>

Moves a non-completed task back to Pending.

Source

pub fn cancel(&self, id: TaskId) -> Result<Task>

Marks a task cancelled.

Source

pub fn run_pending( &self, jobs: usize, cancel: CancellationToken, ) -> Result<Vec<Task>>

Runs every pending task, at most jobs at a time.

Source

pub fn requeue_stale(&self) -> Result<Vec<TaskId>>

Requeues tasks left in Running by a previous process.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more