pub struct SinkMatch<'b> { /* private fields */ }
Expand description

A type that describes a match reported by a searcher.

Implementations§

source§

impl<'b> SinkMatch<'b>

source

pub fn bytes(&self) -> &'b [u8]

Returns the bytes for all matching lines, including the line terminators, if they exist.

source

pub fn lines(&self) -> LineIter<'b>

Return an iterator over the lines in this match.

If multi line search is enabled, then this may yield more than one line (but always at least one line). If multi line search is disabled, then this always reports exactly one line (but may consist of just the line terminator).

Lines yielded by this iterator include their terminators.

source

pub fn absolute_byte_offset(&self) -> u64

Returns the absolute byte offset of the start of this match. This offset is absolute in that it is relative to the very beginning of the input in a search, and can never be relied upon to be a valid index into an in-memory slice.

source

pub fn line_number(&self) -> Option<u64>

Returns the line number of the first line in this match, if available.

Line numbers are only available when the search builder is instructed to compute them.

source

pub fn buffer(&self) -> &'b [u8]

Exposes as much of the underlying buffer that was search as possible.

source

pub fn bytes_range_in_buffer(&self) -> Range<usize>

Returns a range that corresponds to where SinkMatch::bytes appears in SinkMatch::buffer.

Trait Implementations§

source§

impl<'b> Clone for SinkMatch<'b>

source§

fn clone(&self) -> SinkMatch<'b>

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<'b> Debug for SinkMatch<'b>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'b> RefUnwindSafe for SinkMatch<'b>

§

impl<'b> Send for SinkMatch<'b>

§

impl<'b> Sync for SinkMatch<'b>

§

impl<'b> Unpin for SinkMatch<'b>

§

impl<'b> UnwindSafe for SinkMatch<'b>

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