Struct memchr::arch::all::memchr::Three

pub struct Three { /* private fields */ }

Finds all occurrences of three bytes in a haystack.

That is, this reports matches of one of three possible bytes. For example, searching for a, b or o in afoobar would report matches at offsets 0, 2, 3, 4 and 5.

Implementations

impl Three

pub fn new(needle1: u8, needle2: u8, needle3: u8) -> Three

Create a new searcher that finds occurrences of the three needle bytes given.

pub fn find(&self, haystack: &[u8]) -> Option<usize>

Return the first occurrence of one of the needle bytes in the given haystack. If no such occurrence exists, then None is returned.

The occurrence is reported as an offset into haystack. Its maximum value for a non-empty haystack is haystack.len() - 1.

pub fn rfind(&self, haystack: &[u8]) -> Option<usize>

Return the last occurrence of one of the needle bytes in the given haystack. If no such occurrence exists, then None is returned.

The occurrence is reported as an offset into haystack. Its maximum value for a non-empty haystack is haystack.len() - 1.

pub unsafe fn find_raw( &self, start: *const u8, end: *const u8, ) -> Option<*const u8>

Like find, but accepts and returns raw pointers.

When a match is found, the pointer returned is guaranteed to be >= start and < end.

This routine is useful if you’re already using raw pointers and would like to avoid converting back to a slice before executing a search.

Safety

• Both start and end must be valid for reads.
• Both start and end must point to an initialized value.
• Both start and end must point to the same allocated object and must either be in bounds or at most one byte past the end of the allocated object.
• Both start and end must be derived from a pointer to the same object.
• The distance between start and end must not overflow isize.
• The distance being in bounds must not rely on “wrapping around” the address space.

Note that callers may pass a pair of pointers such that start >= end. In that case, None will always be returned.

pub unsafe fn rfind_raw( &self, start: *const u8, end: *const u8, ) -> Option<*const u8>

Like rfind, but accepts and returns raw pointers.

When a match is found, the pointer returned is guaranteed to be >= start and < end.

This routine is useful if you’re already using raw pointers and would like to avoid converting back to a slice before executing a search.

Safety

• Both start and end must be valid for reads.
• Both start and end must point to an initialized value.
• Both start and end must point to the same allocated object and must either be in bounds or at most one byte past the end of the allocated object.
• Both start and end must be derived from a pointer to the same object.
• The distance between start and end must not overflow isize.
• The distance being in bounds must not rely on “wrapping around” the address space.

Note that callers may pass a pair of pointers such that start >= end. In that case, None will always be returned.

pub fn iter<'a, 'h>(&'a self, haystack: &'h [u8]) -> ThreeIter<'a, 'h>

Returns an iterator over all occurrences of one of the needle bytes in the given haystack.

The iterator returned implements DoubleEndedIterator. This means it can also be used to find occurrences in reverse order.

Trait Implementations

impl Clone for Three

fn clone(&self) -> Three

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Three

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

Formats the value using the given formatter.

impl Copy for Three