Skip to main content

ConcurrentRunner

Struct ConcurrentRunner 

Source
pub struct ConcurrentRunner<Config> { /* private fields */ }
Expand description

A runner to process files concurrently.

Implementations§

Source§

impl<Config: 'static + Send + Sync> ConcurrentRunner<Config>

Source

pub fn new<ProcFiles>(num_jobs: usize, proc_files: ProcFiles) -> Self
where ProcFiles: 'static + Fn(PathBuf, &Config) -> Result<()> + Send + Sync,

Creates a new ConcurrentRunner.

  • num_jobs - Number of consumer threads, floored at 1 so 0 does not mean “no workers”.

    Before #1114 this was a budget shared with a dedicated producer thread, and run spawned max(2, num_jobs) - 1 consumers — one slot permanently reserved for a thread that finished almost immediately, costing ~1/N of throughput at --jobs auto. Dispatch now happens on the calling thread, so the whole count goes to consumers and num_jobs means what it says.

  • proc_files - Function that processes each file in the list.

Source

pub fn without_path_verification(self) -> Self

Skip the per-path is_file() check during dispatch.

FilesData::paths is documented as a terminal file list, and the default check is a safety net for a library caller who hands in something else. A caller whose own traversal already classified every entry — the bca CLI walk, which reads the kind straight off the dirent — is paying one redundant stat per file for a question it has already answered (#1114).

Opting out does not make a bad path unsafe: a path that is not a readable regular file still fails at the read in the worker, and that failure is reported through the same per-file error channel as any other unreadable input. It only moves where the run notices.

Source

pub fn run( self, config: Config, files_data: FilesData, ) -> Result<(), ConcurrentErrors>

Runs the producer-consumer pool over the terminal file list in files_data. Each path is dispatched to a worker as a single regular file; this runner performs no directory traversal or glob filtering (the caller resolves and filters the file set — see FilesData).

  • config - Information used to process a file.
  • files_data - The resolved, terminal file list to process.
§Errors

Returns ConcurrentErrors::Thread when one of the num_jobs consumer threads cannot be spawned via std::thread::Builder::spawn; ConcurrentErrors::Sender when a worker cannot place an item (or the post-dispatch None poison-pill) on the channel; ConcurrentErrors::Receiver when a consumer thread panics and its join fails. Per-file processing errors raised by the user-supplied callback are surfaced through the callback itself, not through this Result.

Auto Trait Implementations§

§

impl<Config> !RefUnwindSafe for ConcurrentRunner<Config>

§

impl<Config> !UnwindSafe for ConcurrentRunner<Config>

§

impl<Config> Freeze for ConcurrentRunner<Config>

§

impl<Config> Send for ConcurrentRunner<Config>

§

impl<Config> Sync for ConcurrentRunner<Config>

§

impl<Config> Unpin for ConcurrentRunner<Config>

§

impl<Config> UnsafeUnpin for ConcurrentRunner<Config>

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, 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.