Skip to main content

RipgrepFilesOpts

Struct RipgrepFilesOpts 

Source
pub struct RipgrepFilesOpts<'a> {
Show 16 fields pub glob: Option<&'a str>, pub type_filter: Option<&'a str>, pub output_mode: Option<&'a str>, pub case_insensitive: bool, pub multiline: bool, pub context_before: usize, pub context_after: usize, pub context: usize, pub line_numbers: bool, pub max_results: Option<usize>, pub offset: usize, pub match_limit: Option<usize>, pub skip_dirs: Option<&'a [String]>, pub relative_to: Option<&'a str>, pub respect_gitignore: bool, pub transform: Option<&'a dyn Fn(&str) -> String>,
}
Expand description

Optional knobs for ripgrep_files.

Fields§

§glob: Option<&'a str>

File-name glob (default "*").

§type_filter: Option<&'a str>

File-type filter ("py", "rust", …).

§output_mode: Option<&'a str>

"content" (default) | "files_with_matches" | "count".

§case_insensitive: bool§multiline: bool§context_before: usize§context_after: usize§context: usize

Symmetric context — overridden by context_before / context_after when set.

§line_numbers: bool§max_results: Option<usize>§offset: usize§match_limit: Option<usize>§skip_dirs: Option<&'a [String]>§relative_to: Option<&'a str>§respect_gitignore: bool§transform: Option<&'a dyn Fn(&str) -> String>

Per-file transform applied to raw content before search. Used by the Python wrapper to bridge a Python callable; pure-Rust callers typically leave this None.

Implementations§

Source§

impl<'a> RipgrepFilesOpts<'a>

Source

pub fn new() -> Self

Builder-style helper for the most common defaults.

Trait Implementations§

Source§

impl<'a> Default for RipgrepFilesOpts<'a>

Source§

fn default() -> RipgrepFilesOpts<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for RipgrepFilesOpts<'a>

§

impl<'a> !RefUnwindSafe for RipgrepFilesOpts<'a>

§

impl<'a> !Send for RipgrepFilesOpts<'a>

§

impl<'a> !Sync for RipgrepFilesOpts<'a>

§

impl<'a> Unpin for RipgrepFilesOpts<'a>

§

impl<'a> UnsafeUnpin for RipgrepFilesOpts<'a>

§

impl<'a> !UnwindSafe for RipgrepFilesOpts<'a>

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