[−][src]Struct aeron_rs::concurrent::logbuffer::header::Header
Represents the header of the data frame for accessing meta data fields.
Methods
impl Header
[src]
pub fn new(initial_term_id: i32, capacity: Index) -> Self
[src]
pub fn initial_term_id(&self) -> i32
[src]
Get the initial term id this stream started at.
@return the initial term id this stream started at.
pub fn set_initial_term_id(&mut self, initial_term_id: i32)
[src]
pub fn offset(&self) -> Index
[src]
The offset at which the frame begins.
@return offset at which the frame begins.
pub fn set_offset(&mut self, offset: Index)
[src]
pub fn buffer(&self) -> AtomicBuffer
[src]
The AtomicBuffer containing the header.
@return AtomicBuffer containing the header.
pub fn set_buffer(&mut self, buffer: AtomicBuffer)
[src]
pub fn frame_length(&self) -> Index
[src]
The total length of the frame including the header.
@return the total length of the frame including the header.
pub fn session_id(&self) -> i32
[src]
The session ID to which the frame belongs.
@return the session ID to which the frame belongs.
pub fn stream_id(&self) -> i32
[src]
The stream ID to which the frame belongs.
@return the stream ID to which the frame belongs.
pub fn term_id(&self) -> i32
[src]
The term ID to which the frame belongs.
@return the term ID to which the frame belongs.
pub fn term_offset(&self) -> Index
[src]
The offset in the term at which the frame begins. This will be the same as {@link #offset()}
@return the offset in the term at which the frame begins.
pub fn frame_type(&self) -> u16
[src]
The type of the the frame which should always be {@link DataFrameHeader::HDR_TYPE_DATA}
@return type of the the frame which should always be {@link DataFrameHeader::HDR_TYPE_DATA}
pub fn flags(&self) -> u8
[src]
The flags for this frame. Valid flags are {@link DataFrameHeader::BEGIN_FLAG} and {@link DataFrameHeader::END_FLAG}. A convenience flag {@link DataFrameHeader::BEGIN_AND_END_FLAGS} can be used for both flags.
@return the flags for this frame.
pub fn position(&self) -> i64
[src]
Get the current position to which the Image has advanced on reading this message.
@return the current position to which the Image has advanced on reading this message.
pub fn reserved_value(&self) -> i64
[src]
Get the value stored in the reserve space at the end of a data frame header.
@return the value stored in the reserve space at the end of a data frame header.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Header
impl !Send for Header
impl !Sync for Header
impl Unpin for Header
impl UnwindSafe for Header
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,