rapidsmpf::streaming::ChannelMetadata Struct Reference

Channel-level metadata describing the data stream. More...

#include <channel_metadata.hpp>

Public Member Functions
	ChannelMetadata ()=default
	Default constructor.
	ChannelMetadata (std::uint64_t local_count, Partitioning partitioning={}, bool duplicated=false)
	Construct metadata with specified values. More...
bool	operator== (ChannelMetadata const &) const =default
	Equality comparison. More...

Public Attributes
std::uint64_t	local_count {}
	Local chunk-count estimate for this rank.
Partitioning	partitioning
	How the data is partitioned.
bool	duplicated {}
	Whether data is duplicated on all workers.

Detailed Description

Channel-level metadata describing the data stream.

Contains information about chunk counts, partitioning, and duplication status for the data flowing through a channel.

Definition at line 122 of file channel_metadata.hpp.

Constructor & Destructor Documentation

ChannelMetadata()

rapidsmpf::streaming::ChannelMetadata::ChannelMetadata ( std::uint64_t  local_count, Partitioning  partitioning = {}, bool  duplicated = false  )

inline

Construct metadata with specified values.

Parameters

local_count	Local chunk count.
partitioning	Partitioning metadata (default: no partitioning).
duplicated	Whether data is duplicated (default: false).

Definition at line 137 of file channel_metadata.hpp.

Member Function Documentation

operator==()

bool rapidsmpf::streaming::ChannelMetadata::operator== ( ChannelMetadata const &  ) const

default

Equality comparison.

Returns

True if both metadata objects are equal.

---

The documentation for this struct was generated from the following file:

• /__w/rapidsmpf/rapidsmpf/cpp/include/rapidsmpf/streaming/cudf/channel_metadata.hpp