Struct GetEpochRequest

#[non_exhaustive]
pub struct GetEpochRequest {
    pub epoch: Option<u64>,
    pub read_mask: Option<FieldMask>,
}

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.

epoch: Option<u64>

The requested epoch. If no epoch is provided the current epoch will be returned.

read_mask: Option<FieldMask>

Mask specifying which fields to read. If no mask is specified, defaults to epoch.

Implementations

impl GetEpochRequest

pub const EPOCH_FIELD: &'static MessageField

pub const READ_MASK_FIELD: &'static MessageField

impl GetEpochRequest

pub fn path_builder() -> GetEpochRequestFieldPathBuilder

impl GetEpochRequest

pub const fn const_default() -> Self

pub fn epoch_opt_mut(&mut self) -> Option<&mut u64>

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

pub fn epoch_mut(&mut self) -> &mut u64

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

pub fn epoch_opt(&self) -> Option<u64>

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

pub fn set_epoch<T: Into<u64>>(&mut self, field: T)

Sets epoch with the provided value.

pub fn with_epoch<T: Into<u64>>(self, field: T) -> Self

Sets epoch with the provided value.

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: Into<FieldMask>>(&mut self, field: T)

Sets read_mask with the provided value.

pub fn with_read_mask<T: Into<FieldMask>>(self, field: T) -> Self

Sets read_mask with the provided value.

impl GetEpochRequest

pub fn latest() -> Self

pub fn new(epoch: u64) -> Self

impl GetEpochRequest

pub fn epoch(&self) -> u64

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

Trait Implementations

impl Clone for GetEpochRequest

fn clone(&self) -> GetEpochRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetEpochRequest

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

Formats the value using the given formatter.

impl Default for GetEpochRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetEpochRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for GetEpochRequest

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 GetEpochRequest

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

impl PartialEq for GetEpochRequest

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetEpochRequest