Skip to main content

FileWalker

Struct FileWalker 

Source
pub struct FileWalker<'a, F>
where F: WalkerFs,
{ /* private fields */ }
Expand description

Async file walker, generic over any WalkerFs implementation.

§Examples

use kaish_glob::{FileWalker, WalkOptions, GlobPath};

let walker = FileWalker::new(&my_fs, "src")
    .with_pattern(GlobPath::new("**/*.rs").unwrap())
    .with_options(WalkOptions::default());

let files = walker.collect().await?;

Implementations§

Source§

impl<'a, F> FileWalker<'a, F>
where F: WalkerFs,

Source

pub fn new(fs: &'a F, root: impl AsRef<Path>) -> FileWalker<'a, F>

Create a new file walker starting at the given root.

Source

pub fn with_pattern(self, pattern: GlobPath) -> FileWalker<'a, F>

Set a glob pattern to filter results.

Source

pub fn with_options(self, options: WalkOptions) -> FileWalker<'a, F>

Set walk options.

Source

pub fn with_ignore(self, filter: IgnoreFilter) -> FileWalker<'a, F>

Set the ignore filter explicitly.

Source

pub async fn collect(self) -> Result<Vec<PathBuf>, WalkerError>

Collect all matching paths.

Auto Trait Implementations§

§

impl<'a, F> Freeze for FileWalker<'a, F>

§

impl<'a, F> !RefUnwindSafe for FileWalker<'a, F>

§

impl<'a, F> Send for FileWalker<'a, F>

§

impl<'a, F> Sync for FileWalker<'a, F>

§

impl<'a, F> Unpin for FileWalker<'a, F>

§

impl<'a, F> !UnwindSafe for FileWalker<'a, F>

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<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

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.
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