Struct SubscribeEventsRequest 

#[non_exhaustive]
pub struct SubscribeEventsRequest {
    pub read_mask: Option<FieldMask>,
    pub filter: Option<EventFilter>,
}

Request message for SubscriptionService.SubscribeEvents.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

read_mask: Option<FieldMask>

Optional. Mask for specifying which parts of the Event should be returned.

filter: Option<EventFilter>

Optional. DNF filter over indexed dimensions. If absent, every event is streamed.

Implementations

impl SubscribeEventsRequest

pub const READ_MASK_FIELD: &'static MessageField

pub const FILTER_FIELD: &'static MessageField

impl SubscribeEventsRequest

pub fn path_builder() -> SubscribeEventsRequestFieldPathBuilder

impl SubscribeEventsRequest

pub const fn const_default() -> SubscribeEventsRequest

pub fn read_mask_opt_mut(&mut self) -> Option<&mut FieldMask>

If read_mask is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn read_mask_mut(&mut self) -> &mut FieldMask

Returns a mutable reference to read_mask. If the field is unset, it is first initialized with the default value.

pub fn read_mask_opt(&self) -> Option<&FieldMask>

If read_mask is set, returns Some with the value; otherwise returns None.

pub fn set_read_mask<T>(&mut self, field: T)

where T: Into<FieldMask>,

Sets read_mask with the provided value.

pub fn with_read_mask<T>(self, field: T) -> SubscribeEventsRequest

where T: Into<FieldMask>,

Sets read_mask with the provided value.

pub fn filter(&self) -> &EventFilter

Returns the value of filter, or the default value if filter is unset.

pub fn filter_opt_mut(&mut self) -> Option<&mut EventFilter>

If filter is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn filter_mut(&mut self) -> &mut EventFilter

Returns a mutable reference to filter. If the field is unset, it is first initialized with the default value.

pub fn filter_opt(&self) -> Option<&EventFilter>

If filter is set, returns Some with the value; otherwise returns None.

pub fn set_filter<T>(&mut self, field: T)

where T: Into<EventFilter>,

Sets filter with the provided value.

pub fn with_filter<T>(self, field: T) -> SubscribeEventsRequest

where T: Into<EventFilter>,

Sets filter with the provided value.

Trait Implementations

impl Clone for SubscribeEventsRequest

fn clone(&self) -> SubscribeEventsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeEventsRequest

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

Formats the value using the given formatter.

impl Default for SubscribeEventsRequest

fn default() -> SubscribeEventsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscribeEventsRequest

fn deserialize<D>( deserializer: D, ) -> Result<SubscribeEventsRequest, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for SubscribeEventsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for SubscribeEventsRequest

const FIELDS: &'static [&'static MessageField]

impl PartialEq for SubscribeEventsRequest

fn eq(&self, other: &SubscribeEventsRequest) -> 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 SubscribeEventsRequest

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubscribeEventsRequest