Struct GetCheckpointRequest

#[non_exhaustive]
pub struct GetCheckpointRequest {
    pub read_mask: Option<FieldMask>,
    pub checkpoint_id: Option<CheckpointId>,
}

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>

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

checkpoint_id: Option<CheckpointId>

If neither is provided, return the latest

Implementations

impl GetCheckpointRequest

pub const SEQUENCE_NUMBER_FIELD: &'static MessageField

pub const DIGEST_FIELD: &'static MessageField

pub const READ_MASK_FIELD: &'static MessageField

impl GetCheckpointRequest

pub fn path_builder() -> GetCheckpointRequestFieldPathBuilder

impl GetCheckpointRequest

pub const fn const_default() -> GetCheckpointRequest

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) -> GetCheckpointRequest

where T: Into<FieldMask>,

Sets read_mask with the provided value.

pub fn sequence_number(&self) -> u64

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

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

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

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

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

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

Returns a mutable reference to sequence_number. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

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

where T: Into<u64>,

Sets sequence_number with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_sequence_number<T>(self, field: T) -> GetCheckpointRequest

where T: Into<u64>,

Sets sequence_number with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn digest(&self) -> &str

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

pub fn digest_opt(&self) -> Option<&str>

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

pub fn digest_opt_mut(&mut self) -> Option<&mut String>

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

pub fn digest_mut(&mut self) -> &mut String

Returns a mutable reference to digest. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

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

where T: Into<String>,

Sets digest with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_digest<T>(self, field: T) -> GetCheckpointRequest

where T: Into<String>,

Sets digest with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

impl GetCheckpointRequest

pub fn latest() -> GetCheckpointRequest

pub fn by_sequence_number(checkpoint: u64) -> GetCheckpointRequest

pub fn by_digest(digest: &Digest) -> GetCheckpointRequest

Trait Implementations

impl Clone for GetCheckpointRequest

fn clone(&self) -> GetCheckpointRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCheckpointRequest

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

Formats the value using the given formatter.

impl Default for GetCheckpointRequest

fn default() -> GetCheckpointRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetCheckpointRequest

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for GetCheckpointRequest

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 GetCheckpointRequest

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

impl PartialEq for GetCheckpointRequest

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

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 GetCheckpointRequest