GI.Gio.Structs.FileAttributeMatcher

Determines if a string matches a file attribute.

Exported types

newtype FileAttributeMatcher

Memory-managed wrapper type.

Constructors

FileAttributeMatcher (ManagedPtr FileAttributeMatcher)

Instances

Eq FileAttributeMatcher

Defined in GI.Gio.Structs.FileAttributeMatcher

Methods

(==) :: FileAttributeMatcher -> FileAttributeMatcher -> Bool

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

BoxedObject FileAttributeMatcher

Defined in GI.Gio.Structs.FileAttributeMatcher

Methods

boxedType :: FileAttributeMatcher -> IO GType

IsGValue FileAttributeMatcher

Convert FileAttributeMatcher to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Structs.FileAttributeMatcher

Methods

toGValue :: FileAttributeMatcher -> IO GValue

fromGValue :: GValue -> IO FileAttributeMatcher

noFileAttributeMatcher :: Maybe FileAttributeMatcher

A convenience alias for Nothing :: Maybe FileAttributeMatcher.

Methods

Overloaded methods

enumerateNamespace

fileAttributeMatcherEnumerateNamespace

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> Text

ns: a string containing a file attribute namespace.

-> m Bool

Returns: True if the matcher matches all of the entries in the given ns, False otherwise.

Checks if the matcher will match all of the keys in a given namespace. This will always return True if a wildcard character is in use (e.g. if matcher was created with "standard::*" and ns is "standard", or if matcher was created using "*" and namespace is anything.)

TODO: this is awkwardly worded.

enumerateNext

fileAttributeMatcherEnumerateNext

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> m Text

Returns: a string containing the next attribute or Nothing if no more attribute exist.

Gets the next matched attribute from a FileAttributeMatcher.

matches

fileAttributeMatcherMatches

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> Text

attribute: a file attribute key.

-> m Bool

Returns: True if attribute matches matcher. False otherwise.

Checks if an attribute will be matched by an attribute matcher. If the matcher was created with the "*" matching string, this function will always return True.

matchesOnly

fileAttributeMatcherMatchesOnly

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> Text

attribute: a file attribute key.

-> m Bool

Returns: True if the matcher only matches attribute. False otherwise.

Checks if a attribute matcher only matches a given attribute. Always returns False if "*" was used when creating the matcher.

new

fileAttributeMatcherNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

attributes: an attribute string to match.

-> m FileAttributeMatcher

Returns: a FileAttributeMatcher

Creates a new file attribute matcher, which matches attributes against a given string. GFileAttributeMatchers are reference counted structures, and are created with a reference count of 1. If the number of references falls to 0, the FileAttributeMatcher is automatically destroyed.

The attribute string should be formatted with specific keys separated from namespaces with a double colon. Several "namespace[key](#signal:key)" strings may be concatenated with a single comma (e.g. "standard[type](signal:isHidden)"). The wildcard "*" may be used to match all keys and namespaces, or "namespace::*" will match all keys in a given namespace.

Examples of file attribute matcher strings and results

• "*": matches all attributes.
• "standard::is-hidden": matches only the key is-hidden in the standard namespace.
• "standard::type,unix::*": matches the type key in the standard namespace and all keys in the unix namespace.

ref

fileAttributeMatcherRef

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> m FileAttributeMatcher

Returns: a FileAttributeMatcher.

References a file attribute matcher.

subtract

fileAttributeMatcherSubtract

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: Matcher to subtract from

-> FileAttributeMatcher

subtract: The matcher to subtract

-> m FileAttributeMatcher

Returns: A file attribute matcher matching all attributes of matcher that are not matched by subtract

Subtracts all attributes of subtract from matcher and returns a matcher that supports those attributes.

Note that currently it is not possible to remove a single attribute when the matcher matches the whole namespace - or remove a namespace or attribute when the matcher matches everything. This is a limitation of the current implementation, but may be fixed in the future.

toString

fileAttributeMatcherToString

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> m Text

Returns: a string describing the attributes the matcher matches against or Nothing if matcher was Nothing.

Prints what the matcher is matching against. The format will be equal to the format passed to fileAttributeMatcherNew. The output however, might not be identical, as the matcher may decide to use a different order or omit needless parts.

Since: 2.32

unref

fileAttributeMatcherUnref

Arguments

:: (HasCallStack, MonadIO m)

=> FileAttributeMatcher

matcher: a FileAttributeMatcher.

-> m ()

Unreferences matcher. If the reference count falls below 1, the matcher is automatically freed.