Struct gio::FileAttributeMatcher

pub struct FileAttributeMatcher(_);

Determines if a string matches a file attribute.

Methods

impl FileAttributeMatcher

pub fn new(attributes: &str) -> 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" strings may be concatenated with a single comma (e.g. "standard::type,standard::is-hidden"). 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.

attributes

an attribute string to match.

Returns

a FileAttributeMatcher

pub fn enumerate_namespace(&self, ns: &str) -> bool

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.

ns

a string containing a file attribute namespace.

Returns

true if the matcher matches all of the entries in the given ns, false otherwise.

pub fn matches(&self, attribute: &str) -> bool

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.

attribute

a file attribute key.

Returns

true if attribute matches self. false otherwise.

pub fn matches_only(&self, attribute: &str) -> bool

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

attribute

a file attribute key.

Returns

true if the matcher only matches attribute. false otherwise.

pub fn subtract(
    &self,
    subtract: Option<&FileAttributeMatcher>
) -> Option<FileAttributeMatcher>

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

Note that currently it is not possible to remove a single attribute when the self 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.

subtract

The matcher to subtract

Returns

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

Trait Implementations

impl Clone for FileAttributeMatcher

fn clone(&self) -> FileAttributeMatcher

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileAttributeMatcher

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for FileAttributeMatcher

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for FileAttributeMatcher

impl Hash for FileAttributeMatcher

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IntoIterator for FileAttributeMatcher

type Item = GString

The type of the elements being iterated over.

type IntoIter = FileAttributematcherIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for FileAttributeMatcher

fn cmp(&self, other: &FileAttributeMatcher) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FileAttributeMatcher> for FileAttributeMatcher

fn eq(&self, other: &FileAttributeMatcher) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FileAttributeMatcher) -> bool

This method tests for !=.

impl PartialOrd<FileAttributeMatcher> for FileAttributeMatcher

fn partial_cmp(&self, other: &FileAttributeMatcher) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &FileAttributeMatcher) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &FileAttributeMatcher) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &FileAttributeMatcher) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &FileAttributeMatcher) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FileAttributeMatcher

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for FileAttributeMatcher

impl StructuralPartialEq for FileAttributeMatcher