GI.Vte.Structs.Regex

No description available in the introspection data.

Exported types

newtype Regex

Memory-managed wrapper type.

Constructors

Regex (ManagedPtr Regex)

Instances

Eq Regex

Defined in GI.Vte.Structs.Regex

Methods

(==) :: Regex -> Regex -> Bool

(/=) :: Regex -> Regex -> Bool

GBoxed Regex

Defined in GI.Vte.Structs.Regex

ManagedPtrNewtype Regex

Defined in GI.Vte.Structs.Regex

Methods

toManagedPtr :: Regex -> ManagedPtr Regex

TypedObject Regex

Defined in GI.Vte.Structs.Regex

Methods

glibType :: IO GType

HasParentTypes Regex

Defined in GI.Vte.Structs.Regex

IsGValue (Maybe Regex)

Convert Regex to and from GValue. See toGValue and fromGValue.

Defined in GI.Vte.Structs.Regex

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Regex -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Regex)

type ParentTypes Regex

Defined in GI.Vte.Structs.Regex

type ParentTypes Regex = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

jit, ref, substitute, unref.

Getters

None.

Setters

None.

jit

regexJit

Arguments

:: (HasCallStack, MonadIO m)

=> Regex

regex: a Regex

-> Word32

flags: PCRE2 JIT flags, or 0

-> m ()

(Can throw GError)

If the platform supports JITing, JIT compiles regex.

newForMatch

regexNewForMatch

Arguments

:: (HasCallStack, MonadIO m)

=> Text

pattern: a regex pattern string

-> Int64

patternLength: the length of pattern in bytes, or -1 if the string is NUL-terminated and the length is unknown

-> Word32

flags: PCRE2 compile flags

-> m Regex

Returns: a newly created Regex, or Nothing with error filled in (Can throw GError)

Compiles pattern into a regex for use as a match regex with terminalMatchAddRegex or vte_terminal_event_check_regex_simple().

See man:pcre2pattern(3) for information about the supported regex language.

The regex will be compiled using <literal>PCRE2_UTF</literal> and possibly other flags, in addition to the flags supplied in flags.

newForSearch

regexNewForSearch

Arguments

:: (HasCallStack, MonadIO m)

=> Text

pattern: a regex pattern string

-> Int64

patternLength: the length of pattern in bytes, or -1 if the string is NUL-terminated and the length is unknown

-> Word32

flags: PCRE2 compile flags

-> m Regex

Returns: a newly created Regex, or Nothing with error filled in (Can throw GError)

Compiles pattern into a regex for use as a search regex with terminalSearchSetRegex.

See man:pcre2pattern(3) for information about the supported regex language.

The regex will be compiled using <literal>PCRE2_UTF</literal> and possibly other flags, in addition to the flags supplied in flags.

ref

regexRef

Arguments

:: (HasCallStack, MonadIO m)

=> Regex

regex: a Regex

-> m Regex

Returns: regex

Increases the reference count of regex by one.

substitute

regexSubstitute

Arguments

:: (HasCallStack, MonadIO m)

=> Regex

regex: a Regex

-> Text

subject: the subject string

-> Text

replacement: the replacement string

-> Word32

flags: PCRE2 match flags

-> m Text

Returns: the substituted string, or Nothing if an error occurred (Can throw GError)

See man:pcre2api(3) and man:pcre2_substitute(3) for more information.

Since: 0.56

unref

regexUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Regex

regex: a Regex

-> m Regex

Returns: Nothing

Decreases the reference count of regex by one, and frees regex if the refcount reaches zero.