---
name: "Parse.regex"
section: "3kaya"
platform: "linux"
package: "kaya"
version: "0.4.4-6.2"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/Parse.regex"
---

# Parse.regex(3kaya)

Parse for a regular expression.

## NAME

Parse::regex - Parse for a regular expression.

## SYNOPSIS

**String regex(** *String regexp, var ParseState st* **)**

## ARGUMENTS

**regexp** The regular expression to match against. A **^**  at the start of the expression is implied.

**st** The current parsing state

## DESCRIPTION

This function parses for the specified regular expression at the start of the String, returning the match if one is found, and throwing an Exception otherwise.

## AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

## LICENSE

The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.