Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::filter Class Reference

Log record filter function wrapper. More...

#include <filter.hpp>

Public Types

typedef bool result_type
 Result type. More...
 

Public Member Functions

 filter ()
 Default constructor. More...
 
 filter (filter const &that)
 Copy constructor. More...
 
 filter (BOOST_RV_REF(filter) that) BOOST_NOEXCEPT
 Move constructor. More...
 
template<typename FunT >
 filter (FunT &&fun)
 Initializing constructor. More...
 
filteroperator= (BOOST_RV_REF(filter) that) BOOST_NOEXCEPT
 Move assignment. More...
 
filteroperator= (BOOST_COPY_ASSIGN_REF(filter) that)
 Copy assignment. More...
 
template<typename FunT >
filteroperator= (FunT const &fun)
 Initializing assignment. More...
 
result_type operator() (attribute_value_set const &values) const
 Filtering operator. More...
 
void reset ()
 Resets the filter to the default. More...
 
void swap (filter &that) BOOST_NOEXCEPT
 Swaps two filters. More...
 

Detailed Description

Log record filter function wrapper.

Member Typedef Documentation

Result type.

Constructor & Destructor Documentation

boost::filter::filter ( )
inline

Default constructor.

Creates a filter that always returns true.

Referenced by operator=().

boost::filter::filter ( filter const &  that)
inline

Copy constructor.

boost::filter::filter ( BOOST_RV_REF(filter that)
inline

Move constructor.

The moved-from filter is left in an unspecified state.

template<typename FunT >
boost::filter::filter ( FunT &&  fun)
inline

Initializing constructor.

Creates a filter which will invoke the specified function object.

Member Function Documentation

result_type boost::filter::operator() ( attribute_value_set const &  values) const
inline

Filtering operator.

Parameters
valuesAttribute values of the log record.
Returns
true if the log record passes the filter, false otherwise.
filter& boost::filter::operator= ( BOOST_RV_REF(filter that)
inline

Move assignment.

The moved-from filter is left in an unspecified state.

filter& boost::filter::operator= ( BOOST_COPY_ASSIGN_REF(filter that)
inline

Copy assignment.

template<typename FunT >
filter& boost::filter::operator= ( FunT const &  fun)
inline

Initializing assignment.

Sets the specified function object to the filter.

References filter().

void boost::filter::reset ( void  )
inline

Resets the filter to the default.

The default filter always returns true.

Referenced by boost::sinks::basic_sink_frontend::reset_filter().

void boost::filter::swap ( filter that)
inline

Swaps two filters.


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