Struct rg::subject::Subject

source ·
pub struct Subject {
    dent: DirEntry,
    strip_dot_prefix: bool,
}
Expand description

A subject is a thing we want to search. Generally, a subject is either a file or stdin.

Fields§

§dent: DirEntry§strip_dot_prefix: bool

Implementations§

source§

impl Subject

source

pub fn path(&self) -> &Path

Return the file path corresponding to this subject.

If this subject corresponds to stdin, then a special <stdin> path is returned instead.

source

pub fn is_stdin(&self) -> bool

Returns true if and only if this entry corresponds to stdin.

source

pub fn is_explicit(&self) -> bool

Returns true if and only if this entry corresponds to a subject to search that was explicitly supplied by an end user.

Generally, this corresponds to either stdin or an explicit file path argument. e.g., in rg foo some-file ./some-dir/, some-file is an explicit subject, but, e.g., ./some-dir/some-other-file is not.

However, note that ripgrep does not see through shell globbing. e.g., in rg foo ./some-dir/*, ./some-dir/some-other-file will be treated as an explicit subject.

source

fn is_dir(&self) -> bool

Returns true if and only if this subject points to a directory after following symbolic links.

source

fn is_file(&self) -> bool

Returns true if and only if this subject points to a file.

Trait Implementations§

source§

impl Clone for Subject

source§

fn clone(&self) -> Subject

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Subject

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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.
§

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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.