fetcher 0.15.3

Data automation and pipelining framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

//! This module contains the [`DisabledTask`] type

use crate::{error::FetcherError, maybe_send::MaybeSendSync, task::OpaqueTask};

/// A wrapper type that disables the execution of a task.
///
/// This type wraps a task and implements [`OpaqueTask`] in a way that
/// makes [`OpaqueTask::run`] a no-op.
///
/// See [`OpaqueTask::disable`].
pub struct DisabledTask<T>(pub T);

impl<T> DisabledTask<T> {
	/// Gets the wrapped task out of [`DisabledTask`].
	///
	/// Pattern matching can be used as well.
	pub fn into_inner(self) -> T {
		self.0
	}
}

impl<T: MaybeSendSync> OpaqueTask for DisabledTask<T> {
	async fn run(&mut self) -> Result<(), FetcherError> {
		Ok(())
	}

	fn set_cancel_token(&mut self, _channel: crate::cancellation_token::CancellationToken) {}
}