Struct FilterEventsRequest 

pub struct FilterEventsRequest { /* private fields */ }

Implementations

impl FilterEventsRequest

pub fn new(name: impl Into<String>) -> Self

Constructs a new FilterEventsRequest.

impl FilterEventsRequest

pub fn with_filter(self, value: impl Into<Filter>) -> Self

Specify which event types to allow/disallow

The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated:

"allowed" - Specifies an allowed list of event types "disallowed" - Specifies a disallowed list of event types

Further, each of those key’s value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value: "type" - The type name of the event to filter

The value must be the string name (case sensitive) of the event type that needs filtering. For example:

{ \"allowed\": [ { \"type\": \"StasisStart\" }, { \"type\": \"StasisEnd\" } ] }

As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent.

The following rules apply:

• If the body is empty, both the allowed and disallowed filters are set empty.
• If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty).
• If only one list type is given then only that type is set. The other type is not updated.
• An empty "allowed" list means all events are allowed.
• An empty "disallowed" list means no events are disallowed.
• Disallowed events take precedence over allowed events if the event type is specified in both lists.

Trait Implementations

impl Clone for FilterEventsRequest

fn clone(&self) -> FilterEventsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterEventsRequest

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

Formats the value using the given formatter.

impl PartialEq for FilterEventsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FilterEventsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FilterEventsRequest

impl StructuralPartialEq for FilterEventsRequest