—package
Hyperscan;
$Hyperscan::VERSION
=
'0.04'
;
# ABSTRACT: Perl bindings to the Intel hyperscan regular expression library
use
strict;
use
warnings;
require
XSLoader;
XSLoader::load(
'Hyperscan'
,
$Hyperscan::VERSION
);
use
Hyperscan::Database;
use
Hyperscan::Scratch;
use
Hyperscan::Stream;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Hyperscan - Perl bindings to the Intel hyperscan regular expression library
=head1 VERSION
version 0.04
=head2 SYNOPSIS
use Hyperscan::Matcher;
my $matcher = Hyperscan::Matcher->new([
"one",
qr/More/i,
{ expr => "words" },
]);
$matcher->scan("one or more words to match");
=head2 DESCRIPTION
Hyperscan is a set of XS wrappers around the Intel hyperscan library, a
high-performance regular expression matching library. This library contains two
sets of wrappers.
The first is a set of low level wrappers that offer a direct interface to the c
library, albeit with a more Perlish OO interface.
The second is a high level module meant to provide low friction access to the
most common use cases from a Perl script L<Hyperscan::Matcher>.
=head2 FUNCTIONS
=head3 hs_version()
Utility function for identifying underlying hyperscan release version.
=head2 CONSTANTS
=over
=item HS_MAJOR
=item HS_MINOR
=item HS_PATCH
=item HS_FLAG_CASELESS
=item HS_FLAG_DOTALL
=item HS_FLAG_MULTILINE
=item HS_FLAG_SINGLEMATCH
=item HS_FLAG_ALLOWEMPTY
=item HS_FLAG_UTF8
=item HS_FLAG_UCP
=item HS_FLAG_PREFILTER
=item HS_FLAG_SOM_LEFTMOST
=item HS_FLAG_COMBINATION
=item HS_FLAG_QUIET
=item HS_MODE_BLOCK
=item HS_MODE_NOSTREAM
=item HS_MODE_STREAM
=item HS_MODE_VECTORED
=item HS_MODE_SOM_HORIZON_LARGE
=item HS_MODE_SOM_HORIZON_MEDIUM
=item HS_MODE_SOM_HORIZON_SMALL
=back
=head2 SEE ALSO
=head3 L<Hyperscan::Database>
=head3 L<Hyperscan::Matcher>
=head3 L<Hyperscan::Scratch>
=head3 L<Hyperscan::Stream>
=head3 L<Hyperscan::Util>
=head1 AUTHOR
Mark Sikora <marknsikora@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2020 by Mark Sikora.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut