pub struct KafkaMessage { /* private fields */ }Expand description
A Kafka message containing key, value, headers, and metadata.
Implementations§
Source§impl KafkaMessage
impl KafkaMessage
Sourcepub fn key(&self) -> Option<Cow<'_, str>>
pub fn key(&self) -> Option<Cow<'_, str>>
Returns the message key as a UTF-8 string, if present.
The key is used for partitioning and message ordering within a partition.
Sourcepub fn raw_key(&self) -> Option<&[u8]>
pub fn raw_key(&self) -> Option<&[u8]>
Returns the raw message key as bytes, if present.
This provides access to the unprocessed message key without UTF-8 conversion.
Sourcepub fn value<S>(&self) -> Result<Option<S>, SdkError>where
S: for<'de> Deserialize<'de>,
pub fn value<S>(&self) -> Result<Option<S>, SdkError>where
S: for<'de> Deserialize<'de>,
Deserializes the message value from JSON.
Sourcepub fn raw_value(&self) -> Option<&[u8]>
pub fn raw_value(&self) -> Option<&[u8]>
Returns the raw message value as bytes, if present.
This provides access to the unprocessed message value without any JSON deserialization.
Sourcepub fn into_raw_value(self) -> Option<Vec<u8>>
pub fn into_raw_value(self) -> Option<Vec<u8>>
Consumes the message and returns the raw value as a Vec<u8>, if present.
Sourcepub fn offset(&self) -> i64
pub fn offset(&self) -> i64
Returns the message offset within the partition.
The offset is a unique identifier for the message within its partition.
Sourcepub fn get_header_value<S>(&self, key: &str) -> Result<Option<S>, SdkError>where
S: for<'de> Deserialize<'de>,
pub fn get_header_value<S>(&self, key: &str) -> Result<Option<S>, SdkError>where
S: for<'de> Deserialize<'de>,
Gets a header value by key and deserializes it from JSON.
Returns Ok(Some(value)) if the header exists and can be deserialized,
Ok(None) if the header doesn’t exist,
or Err if deserialization fails.
Sourcepub fn get_raw_header_value(&self, key: &str) -> Option<&[u8]>
pub fn get_raw_header_value(&self, key: &str) -> Option<&[u8]>
Gets a raw header value by key as bytes.
Sourcepub fn timestamp(&self) -> DateTime<Utc>
pub fn timestamp(&self) -> DateTime<Utc>
Returns the timestamp when the message was produced.
The timestamp is in UTC and represents when the message was created.
Sourcepub fn high_watermark(&self) -> i64
pub fn high_watermark(&self) -> i64
Returns the high watermark for the partition.
The high watermark indicates the offset of the last message + 1 in the partition.
Auto Trait Implementations§
impl Freeze for KafkaMessage
impl RefUnwindSafe for KafkaMessage
impl Send for KafkaMessage
impl Sync for KafkaMessage
impl Unpin for KafkaMessage
impl UnwindSafe for KafkaMessage
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);