Skip to main content

Record

Struct Record 

Source
pub struct Record {
    pub offset: i64,
    pub timestamp: i64,
    pub key: Option<Bytes>,
    pub value: Option<Bytes>,
    pub headers: Vec<Header>,
}
Expand description

One record inside a magic-v2 batch.

std::fmt::Display is Java DefaultRecord.toString (key=N bytes; null is 0 bytes, not keySize -1).

Fields§

§offset: i64

Log offset after decode; relative to the batch base when building with RecordBatch::from_records.

§timestamp: i64

Timestamp in milliseconds since the Unix epoch.

§key: Option<Bytes>

Optional key.

§value: Option<Bytes>

Optional value.

§headers: Vec<Header>

Record headers.

Implementations§

Source§

impl Record

Source

pub const EMPTY_HEADERS: &'static [Header]

Java Record.EMPTY_HEADERS.

Source

pub const MAX_RECORD_OVERHEAD: i32 = 21

Java DefaultRecord.MAX_RECORD_OVERHEAD (max bytes excluding key, value, and headers).

Source

pub fn offset(&self) -> i64

Java Record.offset.

Source

pub fn timestamp(&self) -> i64

Java Record.timestamp.

Source

pub fn key(&self) -> Option<&[u8]>

Java Record.key (None is Java null).

Source

pub fn has_key(&self) -> bool

Java Record.hasKey.

Source

pub fn value(&self) -> Option<&[u8]>

Java Record.value (None is Java null).

Source

pub fn has_value(&self) -> bool

Java Record.hasValue.

Source

pub fn key_size(&self) -> i32

Java Record.keySize (-1 when there is no key).

Source

pub fn value_size(&self) -> i32

Java Record.valueSize (-1 when the value is null).

Source

pub fn headers(&self) -> &[Header]

Java Record.headers.

Source

pub fn last_header(&self, key: &str) -> Option<&Header>

Java Headers.lastHeader.

Source

pub fn headers_for_key<'a>( &'a self, key: &'a str, ) -> impl Iterator<Item = &'a Header> + 'a

Java Headers.headers(String).

Source

pub fn has_magic(&self, magic: i8) -> bool

Java Record.hasMagic. Magic-v2 is true when magic is 2 or greater.

Source

pub fn is_compressed(&self) -> bool

Java DefaultRecord.isCompressed (always false; compression is on the batch).

Source

pub fn has_timestamp_type(&self, _timestamp_type: TimestampType) -> bool

Java DefaultRecord.hasTimestampType (always false; timestamp type is on the batch).

Source

pub fn size_of_body_in_bytes( &self, offset_delta: i32, timestamp_delta: i64, ) -> Result<i32>

Java DefaultRecord.sizeOfBodyInBytes (no length-prefix varint).

offset_delta / timestamp_delta are the magic-v2 relative fields (offset - baseOffset, timestamp - baseTimestamp).

Source

pub fn size_in_bytes( &self, offset_delta: i32, timestamp_delta: i64, ) -> Result<i32>

Java DefaultRecord.sizeInBytes(int, long, ByteBuffer, ByteBuffer, Header[]).

Body size plus the zigzag varint that prefixes the body on the wire.

Source

pub fn record_size_upper_bound(&self) -> Result<i32>

Java DefaultRecord.recordSizeUpperBound (MAX_RECORD_OVERHEAD plus key, value, and headers; not the on-wire size).

Source

pub fn from_end_transaction_marker( timestamp: i64, marker: &EndTransactionMarker, ) -> Result<Self>

Control record for EndTransactionMarker (Java MemoryRecordsBuilder.appendEndTxnMarker).

Trait Implementations§

Source§

impl Clone for Record

Source§

fn clone(&self) -> Record

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Record

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Record

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Record

Source§

impl PartialEq for Record

Source§

fn eq(&self, other: &Record) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Record

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more