GI.GLib.Structs.PatternSpec

A GPatternSpec struct is the 'compiled' form of a pattern. This structure is opaque and its fields cannot be accessed directly.

Exported types

newtype PatternSpec

Memory-managed wrapper type.

Constructors

PatternSpec (ManagedPtr PatternSpec)

Instances

Eq PatternSpec

Defined in GI.GLib.Structs.PatternSpec

Methods

(==) :: PatternSpec -> PatternSpec -> Bool

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

GBoxed PatternSpec

Defined in GI.GLib.Structs.PatternSpec

ManagedPtrNewtype PatternSpec

Defined in GI.GLib.Structs.PatternSpec

Methods

toManagedPtr :: PatternSpec -> ManagedPtr PatternSpec

TypedObject PatternSpec

Defined in GI.GLib.Structs.PatternSpec

Methods

glibType :: IO GType

HasParentTypes PatternSpec

Defined in GI.GLib.Structs.PatternSpec

IsGValue (Maybe PatternSpec)

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

Defined in GI.GLib.Structs.PatternSpec

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PatternSpec

Defined in GI.GLib.Structs.PatternSpec

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

Methods

Click to display all available methods, including inherited ones

Methods

copy, equal, free, match, matchString.

Getters

None.

Setters

None.

copy

patternSpecCopy

Arguments

:: (HasCallStack, MonadIO m)

=> PatternSpec

pspec: a PatternSpec

-> m PatternSpec

Returns: a copy of pspec.

Copies pspec in a new PatternSpec.

Since: 2.70

equal

patternSpecEqual

Arguments

:: (HasCallStack, MonadIO m)

=> PatternSpec

pspec1: a PatternSpec

-> PatternSpec

pspec2: another PatternSpec

-> m Bool

Returns: Whether the compiled patterns are equal

Compares two compiled pattern specs and returns whether they will match the same set of strings.

free

patternSpecFree

Arguments

:: (HasCallStack, MonadIO m)

=> PatternSpec

pspec: a PatternSpec

-> m ()

Frees the memory allocated for the PatternSpec.

match

patternSpecMatch

Arguments

:: (HasCallStack, MonadIO m)

=> PatternSpec

pspec: a PatternSpec

-> Word64

stringLength: the length of string (in bytes, i.e. strlen(), not utf8Strlen)

-> Text

string: the UTF-8 encoded string to match

-> Maybe Text

stringReversed: the reverse of string or Nothing

-> m Bool

Returns: True if string matches pspec

Matches a string against a compiled pattern. Passing the correct length of the string given is mandatory. The reversed string can be omitted by passing Nothing, this is more efficient if the reversed version of the string to be matched is not at hand, as g_pattern_match() will only construct it if the compiled pattern requires reverse matches.

Note that, if the user code will (possibly) match a string against a multitude of patterns containing wildcards, chances are high that some patterns will require a reversed string. In this case, it's more efficient to provide the reversed string to avoid multiple constructions thereof in the various calls to g_pattern_match().

Note also that the reverse of a UTF-8 encoded string can in general not be obtained by strreverse. This works only if the string does not contain any multibyte characters. GLib offers the utf8Strreverse function to reverse UTF-8 encoded strings.

Since: 2.70

matchString

patternSpecMatchString

Arguments

:: (HasCallStack, MonadIO m)

=> PatternSpec

pspec: a PatternSpec

-> Text

string: the UTF-8 encoded string to match

-> m Bool

Returns: True if string matches pspec

Matches a string against a compiled pattern. If the string is to be matched against more than one pattern, consider using g_pattern_match() instead while supplying the reversed string.

Since: 2.70

new

patternSpecNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

pattern: a zero-terminated UTF-8 encoded string

-> m PatternSpec

Returns: a newly-allocated PatternSpec

Compiles a pattern to a PatternSpec.