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
55
56

use core::arch::aarch64::int8x16_t;

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

type NeonVector = int8x16_t;

/// A function that performs escape operations using NEON SIMD 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, writer: impl Writer<R>) -> Result<(), R> {
    let len = haystack.len();
    if len < NeonVector::BYTES {
        return <E::Escapes<()> as Escapes>::byte_byte_escape(haystack, writer);
    }

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

/// A macro for creating a escape functions
///
/// # Parameters
/// - `$builder`: The type [`crate::EscapesBuilder`] of the builder
#[macro_export]
macro_rules! escape_builder {
    ($builder:ty) => {
        $crate::struct_string!($crate::builder_string!(
            escape_string,
            $crate::arch::aarch64::escape,
            escape,
            $builder
        ));
        $crate::struct_bytes!($crate::builder_bytes!(
            escape_bytes,
            $crate::arch::aarch64::escape,
            escape,
            $builder
        ));
        $crate::struct_display!(
            escape_fmt,
            escape_fmt_internal,
            $crate::builder_fmt!(
                escape_fmt_internal,
                $crate::arch::aarch64::escape,
                escape,
                $builder
            ),
            $builder
        );
    };
}