ChannelDescriptor#

pub struct ChannelDescriptor#

A descriptor for a channel.

Note that this is used internally to compare channels.

Fields#

pub name: String#

The name of the channel.

pub tags: Option<Arc<BTreeMap<String, String>>>#

The tags associated with the channel, if any.

Shared rather than owned: a wide record is thousands of channels written at one timestamp all carrying the same tags, so a descriptor per channel would otherwise mean copying the same map thousands of times per write.

Implementations#

impl ChannelDescriptor
pub fn new(name: impl Into<String>) -> Self#

Creates a new channel descriptor from the given name.

If you would like to include tags, see also Self::with_tags.

pub fn with_tags(name: impl Into<String>, tags: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>) -> Self#

Creates a new channel descriptor from the given name and tags.

Trait implementations#

Derived: Clone, Debug, Eq, Hash, StructuralPartialEq, PartialEq, Ord, PartialOrd

Auto traits: Send, Sync, Unpin, UnwindSafe, RefUnwindSafe