v_escape-base 0.1.0

Base runtime for v_escape: SIMD-accelerated string escaping primitives.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use core::arch::x86_64::{__m128i, __m256i};

use crate::{Escapes, EscapesBuilder, Vector, generic::Generic, writer::Writer};

// Adapted from https://github.com/BurntSushi/memchr/blob/master/src/arch/x86_64/avx2/memchr.rs
/// Returns true if AVX2 is available in the current environment.
pub fn is_available() -> bool {
    #[cfg(not(target_feature = "sse2"))]
    {
        false
    }
    #[cfg(target_feature = "sse2")]
    {
        #[cfg(target_feature = "avx2")]
        {
            true
        }
        #[cfg(not(target_feature = "avx2"))]
        {
            #[cfg(feature = "std")]
            {
                std::is_x86_feature_detected!("avx2")
            }
            #[cfg(not(feature = "std"))]
            {
                false
            }
        }
    }
}

type AvxVector = __m256i;
type SseVector = __m128i;

/// A function that performs escape operations using AVX and SSE vectorization.
///
/// # Parameters
/// - `haystack`: The input string to be escaped.
/// - `writer`: The writer function.
///
/// # Returns
/// A result indicating success or failure of the escape operation.
#[inline(always)]
pub fn escape<E: EscapesBuilder, R>(haystack: &str, mut writer: impl Writer<R>) -> Result<(), R> {
    let len = haystack.len();
    if len < AvxVector::BYTES {
        if len < SseVector::BYTES {
            return <E::Escapes<()> as Escapes>::byte_byte_escape(haystack, &mut writer);
        }
        return Generic::new(E::new::<SseVector>()).escape(haystack, writer);
    }

    Generic::new(E::new::<AvxVector>()).escape(haystack, writer)
}