Pixar Arch
Loading...
Searching...
No Matches
pxr::ArchRegex Class Reference

#include <regex.h>

Public Types

enum  : unsigned int { CASE_INSENSITIVE = 1u , GLOB = 2u }
 

Public Member Functions

 ArchRegex ()=default
 Create an empty regex.
 
 ArchRegex (ArchRegex &&) noexcept=default
 
 ArchRegex (ArchRegex const &)=default
 
ArchRegexoperator= (ArchRegex &&) noexcept=default
 
ArchRegexoperator= (ArchRegex const &)=default
 
ARCH_API ArchRegex (const std::string &pattern, unsigned int flags=0)
 Create with pattern and optional flags.
 
ARCH_API ~ArchRegex ()
 Destructor.
 
ARCH_API operator bool () const
 Returns true if the regex is valid.
 
ARCH_API std::string GetError () const
 Returns the reason the regex is invalid or the empty string if it's valid.
 
ARCH_API unsigned int GetFlags () const
 Returns the flags used to construct the regex.
 
ARCH_API bool Match (const std::string &query) const
 Returns true if the regex matches query anywhere, otherwise returns false.
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned int
Enumerator
CASE_INSENSITIVE 
GLOB 

Constructor & Destructor Documentation

◆ ArchRegex() [1/4]

pxr::ArchRegex::ArchRegex ( )
default

Create an empty regex.

◆ ArchRegex() [2/4]

pxr::ArchRegex::ArchRegex ( ArchRegex && )
defaultnoexcept

◆ ArchRegex() [3/4]

pxr::ArchRegex::ArchRegex ( ArchRegex const & )
default

◆ ArchRegex() [4/4]

ARCH_API pxr::ArchRegex::ArchRegex ( const std::string & pattern,
unsigned int flags = 0 )

Create with pattern and optional flags.

◆ ~ArchRegex()

ARCH_API pxr::ArchRegex::~ArchRegex ( )

Destructor.

Member Function Documentation

◆ operator=() [1/2]

ArchRegex & pxr::ArchRegex::operator= ( ArchRegex && )
defaultnoexcept

◆ operator=() [2/2]

ArchRegex & pxr::ArchRegex::operator= ( ArchRegex const & )
default

◆ operator bool()

ARCH_API pxr::ArchRegex::operator bool ( ) const
explicit

Returns true if the regex is valid.

◆ GetError()

ARCH_API std::string pxr::ArchRegex::GetError ( ) const

Returns the reason the regex is invalid or the empty string if it's valid.

◆ GetFlags()

ARCH_API unsigned int pxr::ArchRegex::GetFlags ( ) const

Returns the flags used to construct the regex.

◆ Match()

ARCH_API bool pxr::ArchRegex::Match ( const std::string & query) const

Returns true if the regex matches query anywhere, otherwise returns false.


The documentation for this class was generated from the following file: