Enum SearchResult

pub enum SearchResult {
    Found(usize),
    NotFound(usize),
}

Result of performing search_sorted on an Array

Variants

Found(usize)

Result for a found element was found at the given index in the sorted array

NotFound(usize)

Result for an element not found, but that could be inserted at the given position in the sorted order.

Implementations

impl SearchResult

pub fn to_found(self) -> Option<usize>

Convert search result to an index only if the value have been found

pub fn to_index(self) -> usize

Extract index out of search result regardless of whether the value have been found or not

pub fn to_offsets_index(self, len: usize) -> usize

Convert search result into an index suitable for searching array of offset indices, i.e. first element starts at 0.

For example for a ChunkedArray with chunk offsets array [0, 3, 8, 10] you can use this method to obtain index suitable for indexing into it after performing a search

pub fn to_ends_index(self, len: usize) -> usize

Convert search result into an index suitable for searching array of end indices without 0 offset, i.e. first element implicitly covers 0..0th-element range.

For example for a RunEndArray with ends array [3, 8, 10], you can use this method to obtain index suitable for indexing into it after performing a search

pub fn map<F>(self, f: F) -> SearchResult

where F: FnOnce(usize) -> usize,

Apply a transformation to the Found or NotFound index.

Trait Implementations

impl Clone for SearchResult

fn clone(&self) -> SearchResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResult

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

Formats the value using the given formatter.

impl Display for SearchResult

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

Formats the value using the given formatter.

impl PartialEq for SearchResult

fn eq(&self, other: &SearchResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SearchResult

impl Eq for SearchResult

impl StructuralPartialEq for SearchResult