class documentation

class SearchMatchType(bb.Union): (source)

View In Hierarchy

Indicates what type of match was found for a given item. This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar files.SearchMatchType.filename: This item was matched on its file or folder name. :ivar files.SearchMatchType.content: This item was matched based on its file contents. :ivar files.SearchMatchType.both: This item was matched based on both its contents and its file name.

Method is_both Check if the union tag is ``both``.
Method is_content Check if the union tag is ``content``.
Method is_filename Check if the union tag is ``filename``.
Class Variable both Undocumented
Class Variable content Undocumented
Class Variable filename Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_both(self): (source)

Check if the union tag is ``both``. :rtype: bool

def is_content(self): (source)

Check if the union tag is ``content``. :rtype: bool

def is_filename(self): (source)

Check if the union tag is ``filename``. :rtype: bool

Undocumented

Undocumented

filename = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all = (source)

Undocumented