onig 2.0.0

Rust-Onig is a set of rust bindings for the oniguruma regular expression library.
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
57
58
59
60
61
62
63

# Rust Onig

[![Build Status](https://travis-ci.org/rust-onig/rust-onig.svg?branch=master)](https://travis-ci.org/rust-onig/rust-onig)
[![Build status](https://ci.appveyor.com/api/projects/status/7qxdb44xpw4bkjfi/branch/master?svg=true)](https://ci.appveyor.com/project/iwillspeak/rust-onig/branch/master)

Rust bindings for the [Oniguruma regex library][Onig_wiki], a powerful and mature regular expression library with support for a wide range of character sets and language syntaxes. Oniguruma is written in C. This repository provides two crates: `onig-sys` which provides the raw Rust FFI bindings, and `onig`, which provides a safe Rust wrapper around them.

## Documentation

Check out the [module documentation][onig_crate_doc] to find out all the features that are available. To see some example usage of this crate take a look a the [examples folder][examples_folder]. The examples can be run from the command line with `cargo run --example <examplename>`.

## Getting Started

Add the following to your `Cargo.toml` file:

```toml
[dependencies]
onig = "2.0"
```

Add the following extern to your crate root:

```rust
extern crate onig;
```

You can can compile simple regular expressions with [`Regex::new`][regex_new], check if the pattern matches an entire `&str`  with [`Regex::is_match`][regex_is_match] and find matches within a `&str` with [`Regex::find`][regex_find]. The `onig` crate also supplies more powerful versions of these methods which expose the wide range of options Oniguruma provides.

```rust
use onig::*;

let regex = Regex::new("e(l+)").unwrap();
for (i, pos) in regex.captures("hello").unwrap().iter_pos().enumerate() {
    match pos {
         Some((beg, end)) =>
             println!("Group {} captured in position {}:{}", i, beg, end),
         None =>
             println!("Group {} is not captured", i)
    }
}
```

## Static Linking

By default `rust-onig` will be dynamically lined to `libonig`. If your would rather that static linking is used then the environment variable `RUSTONIG_STATIC_LIBONIG` can be set. On *nix:

    $ RUSTONIG_STATIC_LIBONING=1 cargo build

Or Windows:

    > set RUSTONIG_STATIC_LIBONIG=1
    > cargo build

## Rust-Onig is Open Source

The contents of this repository are distributed under the MIT license. See [LICENSE](LICENSE.md) for more details.

 [Onig_wiki]: https://en.wikipedia.org/wiki/Oniguruma
 [onig_crate_doc]: https://docs.rs/onig/2.0.0/onig/
 [examples_folder]: https://github.com/rust-onig/rust-onig/tree/master/examples
 [regex_new]: https://docs.rs/onig/2.0.0/onig/struct.Regex.html#method.new
 [regex_is_match]: https://docs.rs/onig/2.0.0/onig/struct.Regex.html#method.is_match
 [regex_find]: https://docs.rs/onig/2.0.0/onig/struct.Regex.html#method.find