Struct FileDiscovery

Source

pub struct FileDiscovery { /* private fields */ }

Expand description

Project file scanner. Walks directory respecting .gitignore.

Implementations§

Source §

impl FileDiscovery

Source

pub fn new(project_root: impl AsRef<Path>) -> Self

Create a new scanner for the given project root.

Source

pub fn with_excludes(self, excludes: Vec<String>) -> Self

Add glob patterns to exclude from scanning.

Source

pub fn with_includes(self, includes: Vec<String>) -> Self

Add glob patterns to include (whitelist mode, or override excludes).

Source

pub fn with_gitignore(self, use_gitignore: bool) -> Self

Enable or disable .gitignore processing.

Source

pub fn with_custom_ignore_file(self, path: impl AsRef<Path>) -> Self

Add a custom ignore file path (e.g. a shared .kardo.ignore).

Source

pub fn discover(&self) -> Result<Vec<DiscoveredFile>, ScanError>

Scan project directory, respecting .gitignore and filtering rules. Returns all relevant documentation files sorted by relative_path.

Auto Trait Implementations§

§

impl UnwindSafe for FileDiscovery

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §