pub struct RemoteLogSegmentMetadata { /* private fields */ }Expand description
Metadata for one segment that is stored, or is being stored, in the remote tier.
Implementations§
Source§impl RemoteLogSegmentMetadata
impl RemoteLogSegmentMetadata
Sourcepub fn new(
remote_log_segment_id: RemoteLogSegmentId,
start_offset: i64,
end_offset: i64,
max_timestamp_ms: i64,
broker_id: i32,
event_timestamp_ms: i64,
details: RemoteLogSegmentDetails,
) -> Result<Self, RemoteStorageError>
pub fn new( remote_log_segment_id: RemoteLogSegmentId, start_offset: i64, end_offset: i64, max_timestamp_ms: i64, broker_id: i32, event_timestamp_ms: i64, details: RemoteLogSegmentDetails, ) -> Result<Self, RemoteStorageError>
Constructs a RemoteLogSegmentMetadata.
§Errors
Returns RemoteStorageError::InvalidArgument when
segment_leader_epochs is empty, end_offset < start_offset, or
segment_size_in_bytes < 0.
Sourcepub fn with_update(
&self,
update: &RemoteLogSegmentMetadataUpdate,
) -> Result<Self, RemoteStorageError>
pub fn with_update( &self, update: &RemoteLogSegmentMetadataUpdate, ) -> Result<Self, RemoteStorageError>
Applies a RemoteLogSegmentMetadataUpdate and returns the updated
copy. The update advances state, refreshes event_timestamp_ms
and broker_id, and replaces custom_metadata when the update
carries Some.
§Errors
Returns RemoteStorageError::InvalidArgument if the update’s
segment id does not match, or
RemoteStorageError::InvalidSegmentTransition if the state change
is not permitted from the current state.
Sourcepub fn remote_log_segment_id(&self) -> &RemoteLogSegmentId
pub fn remote_log_segment_id(&self) -> &RemoteLogSegmentId
The segment’s unique id.
Sourcepub fn start_offset(&self) -> i64
pub fn start_offset(&self) -> i64
First offset (inclusive) covered by this segment.
Sourcepub fn end_offset(&self) -> i64
pub fn end_offset(&self) -> i64
Last offset (inclusive) covered by this segment.
Sourcepub fn max_timestamp_ms(&self) -> i64
pub fn max_timestamp_ms(&self) -> i64
Highest record timestamp in this segment.
Sourcepub fn event_timestamp_ms(&self) -> i64
pub fn event_timestamp_ms(&self) -> i64
Wall-clock time the latest event for this segment was created.
Sourcepub fn segment_size_in_bytes(&self) -> i32
pub fn segment_size_in_bytes(&self) -> i32
Size of the .log data in bytes.
Sourcepub fn custom_metadata(&self) -> Option<&CustomMetadata>
pub fn custom_metadata(&self) -> Option<&CustomMetadata>
Opaque metadata the RemoteStorageManager
attached at copy time, if any.
Sourcepub fn state(&self) -> RemoteLogSegmentState
pub fn state(&self) -> RemoteLogSegmentState
Current lifecycle state.
Sourcepub fn segment_leader_epochs(&self) -> &BTreeMap<LeaderEpoch, i64>
pub fn segment_leader_epochs(&self) -> &BTreeMap<LeaderEpoch, i64>
Map of leader epoch → first offset that epoch contributed to this segment.
Sourcepub fn epoch_bounds(&self, epoch: LeaderEpoch) -> (Option<i64>, Option<i64>)
pub fn epoch_bounds(&self, epoch: LeaderEpoch) -> (Option<i64>, Option<i64>)
The first offset of epoch and the earliest offset belonging to a later epoch.
Sourcepub fn with_custom_metadata(self, custom: CustomMetadata) -> Self
pub fn with_custom_metadata(self, custom: CustomMetadata) -> Self
Attaches custom metadata in builder style. RSM copy paths use it when
they produce a key before they record CopySegmentFinished.
Sourcepub fn txn_index_empty(&self) -> bool
pub fn txn_index_empty(&self) -> bool
true if the segment has no transaction index (KIP-405 txnIndexEmpty).
Defaults to false. Serialized as the JVM record’s tagged field (tag 0).
Sourcepub fn with_txn_index_empty(self, empty: bool) -> Self
pub fn with_txn_index_empty(self, empty: bool) -> Self
Builder-style setter for Self::txn_index_empty.
Trait Implementations§
Source§impl Clone for RemoteLogSegmentMetadata
impl Clone for RemoteLogSegmentMetadata
Source§fn clone(&self) -> RemoteLogSegmentMetadata
fn clone(&self) -> RemoteLogSegmentMetadata
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RemoteLogSegmentMetadata
impl Debug for RemoteLogSegmentMetadata
impl Eq for RemoteLogSegmentMetadata
Source§impl PartialEq for RemoteLogSegmentMetadata
impl PartialEq for RemoteLogSegmentMetadata
impl StructuralPartialEq for RemoteLogSegmentMetadata
Auto Trait Implementations§
impl Freeze for RemoteLogSegmentMetadata
impl RefUnwindSafe for RemoteLogSegmentMetadata
impl Send for RemoteLogSegmentMetadata
impl Sync for RemoteLogSegmentMetadata
impl Unpin for RemoteLogSegmentMetadata
impl UnsafeUnpin for RemoteLogSegmentMetadata
impl UnwindSafe for RemoteLogSegmentMetadata
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.impl<F> FnGhost for F
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> 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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§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>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§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);