Struct aho_corasick::Span
source · pub struct Span {
pub start: usize,
pub end: usize,
}
Expand description
A representation of a range in a haystack.
A span corresponds to the starting and ending byte offsets of a contiguous region of bytes. The starting offset is inclusive while the ending offset is exclusive. That is, a span is a half-open interval.
A span is used to report the offsets of a match, but it is also used to
convey which region of a haystack should be searched via routines like
Input::span
.
This is basically equivalent to a std::ops::Range<usize>
, except this
type implements Copy
which makes it more ergonomic to use in the context
of this crate. Indeed, Span
exists only because Range<usize>
does
not implement Copy
. Like a range, this implements Index
for [u8]
and str
, and IndexMut
for [u8]
. For convenience, this also impls
From<Range>
, which means things like Span::from(5..10)
work.
There are no constraints on the values of a span. It is, for example, legal
to create a span where start > end
.
Fields§
§start: usize
The start offset of the span, inclusive.
end: usize
The end offset of the span, exclusive.
Implementations§
source§impl Span
impl Span
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true when this span is empty. That is, when start >= end
.
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the length of this span.
This returns 0
in precisely the cases that is_empty
returns true
.
Trait Implementations§
source§impl PartialEq<Range<usize>> for Span
impl PartialEq<Range<usize>> for Span
source§impl PartialEq for Span
impl PartialEq for Span
impl Copy for Span
impl Eq for Span
impl StructuralPartialEq for Span
Auto Trait Implementations§
impl Freeze for Span
impl RefUnwindSafe for Span
impl Send for Span
impl Sync for Span
impl Unpin for Span
impl UnwindSafe for Span
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)