Struct mz_compute_client::protocol::response::FrontiersResponse

pub struct FrontiersResponse<T = Timestamp> {
    pub write_frontier: Option<Antichain<T>>,
    pub input_frontier: Option<Antichain<T>>,
    pub output_frontier: Option<Antichain<T>>,
}

A response reporting advancement of frontiers of a compute collection.

All contained frontier fields are optional. None values imply that the respective frontier has not advanced and the previously reported value is still current.

Fields

write_frontier: Option<Antichain<T>>

The collection’s new write frontier, if any.

Upon receiving an updated write_frontier, the controller may assume that the contents of the collection are sealed for all times less than that frontier. Once it has reported the write_frontier as the empty frontier, the replica must no longer change the contents of the collection.

input_frontier: Option<Antichain<T>>

The collection’s new input frontier, if any.

Upon receiving an updated input_frontier, the controller may assume that the replica has finished reading from the collection’s inputs up to that frontier. Once it has reported the input_frontier as the empty frontier, the replica must no longer read from the collection’s inputs.

output_frontier: Option<Antichain<T>>

The collection’s new output frontier, if any.

Upon receiving an updated output_frontier, the controller may assume that the replica has finished processing the collection’s input up to that frontier.

The output_frontier is often equal to the write_frontier, but not always. Some collections can jump their write frontiers ahead of the times they have finished processing, causing the output_frontier to lag behind the write_frontier. Collections writing materialized views do so in two cases:

• REFRESH MVs jump their write frontier ahead to the next refresh time.
• In a multi-replica cluster, slower replicas observe and report the write frontier of the fastest replica, by witnessing advancements of the target persist shard’s upper.

Implementations

impl<T> FrontiersResponse<T>

pub fn has_updates(&self) -> bool

Returns whether there are any contained updates.

Trait Implementations

impl Arbitrary for FrontiersResponse

type Strategy = BoxedStrategy<FrontiersResponse>

The type of Strategy used to generate values of type Self.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl<T: Clone> Clone for FrontiersResponse<T>

fn clone(&self) -> FrontiersResponse<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FrontiersResponse<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for FrontiersResponse<T>

fn default() -> FrontiersResponse<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for FrontiersResponse<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for FrontiersResponse<T>

fn eq(&self, other: &FrontiersResponse<T>) -> 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 RustType<ProtoFrontiersResponse> for FrontiersResponse

fn into_proto(&self) -> ProtoFrontiersResponse

Convert a Self into a Proto value.

fn from_proto(proto: ProtoFrontiersResponse) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl<T> Serialize for FrontiersResponse<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for FrontiersResponse<T>