Struct grep_searcher::SinkContext

pub struct SinkContext<'b> { /* private fields */ }

A type that describes a contextual line reported by a searcher.

Implementations

impl<'b> SinkContext<'b>

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

Returns the context bytes, including line terminators.

pub fn kind(&self) -> &SinkContextKind

Returns the type of context.

pub fn absolute_byte_offset(&self) -> u64

Returns the absolute byte offset of the start of this context. 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.

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

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

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

Trait Implementations

impl<'b> Clone for SinkContext<'b>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'b> Debug for SinkContext<'b>

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

Formats the value using the given formatter.