Struct Tailer 

pub struct Tailer<T: IdentityType> { /* private fields */ }

Tailer view (16 + TYPHOON_ID_LENGTH bytes total). Zero-copy view into a DynamicByteBuffer containing tailer metadata. All field access reads directly from the underlying buffer.

Layout:

• FG (flags): 1 byte - packet type flags
• CD (code): 1 byte - client type or return code
• TM (time): 4 bytes - next_in delay in milliseconds
• PN (packet number): 8 bytes - timestamp (4) + incremental (4)
• PL (payload length): 2 bytes - length of encrypted payload
• ID (identity): TYPHOON_ID_LENGTH bytes - client UUID

Implementations

impl<T: IdentityType> Tailer<T>

pub fn new(buffer: DynamicByteBuffer) -> Self

Wrap an existing buffer as a tailer view. No data is copied. The buffer must contain at least Self::len() bytes.

pub fn validated(buffer: DynamicByteBuffer, body_len: usize) -> Option<Self>

Construct a tailer view from a received buffer and validate it against the accompanying body length. Unlike Tailer::new, this constructor never expands the buffer via the pool — receive paths must supply a slice whose length is already at least Self::len().

pub fn data( buffer: DynamicByteBuffer, identity: &T, payload_length: u16, packet_number: u64, ) -> Self

Write a data packet tailer into the buffer.

pub fn health_check( buffer: DynamicByteBuffer, identity: &T, next_in: u32, packet_number: u64, ) -> Self

Write a health check packet tailer into the buffer.

pub fn shadowride( buffer: DynamicByteBuffer, identity: &T, payload_length: u16, next_in: u32, packet_number: u64, ) -> Self

Write a shadowride packet tailer (data + health check) into the buffer.

pub fn handshake( buffer: DynamicByteBuffer, identity: &T, code: u8, next_in: u32, packet_number: u64, body_len: u16, ) -> Self

Write a handshake packet tailer into the buffer. body_len is the length of the handshake body (excluding tailer), allowing receivers to strip any fake header/body prefix before parsing the handshake data.

pub fn decoy( buffer: DynamicByteBuffer, identity: &T, packet_number: u64, ) -> Self

Write a decoy packet tailer into the buffer.

pub fn debug_probe( buffer: DynamicByteBuffer, identity: &T, ref_num: u8, send_time_ms: u32, sequence: u32, phase: u32, payload_len: u16, ) -> Self

Write a debug probe tailer into the buffer.

Field semantics in debug mode:

• FG: DATA flag (same as data packets so probes blend in).
• CD: ref_num — rolling reference number (0–255) uniquely identifying this probe.
• TM: send_time_ms — lower 32 bits of the Unix send timestamp in milliseconds.
• PN: sequence << 32 | phase — global sequence number and debug phase identifier.
• PL: payload_len — length of the probe payload.

pub fn termination( buffer: DynamicByteBuffer, identity: &T, code: ReturnCode, packet_number: u64, ) -> Self

Write a termination packet tailer into the buffer.

pub fn flags(&self) -> PacketFlags

pub fn code(&self) -> u8

pub fn time(&self) -> u32

pub fn packet_number(&self) -> u64

pub fn payload_length(&self) -> u16

pub fn identity(&self) -> T

pub fn timestamp(&self) -> u32

Extract timestamp from packet number (upper 32 bits).

pub fn incremental(&self) -> u32

Extract incremental number from packet number (lower 32 bits).

pub fn return_code(&self) -> ReturnCode

Get return code from code field.

pub fn debug_ref_num(&self) -> u8

Debug: rolling reference number from the CD field (0–255).

pub fn debug_send_time(&self) -> u32

Debug: send timestamp in milliseconds from the TM field (lower 32 bits of Unix time).

pub fn debug_sequence(&self) -> u32

Debug: global probe sequence number from the upper 32 bits of the PN field.

pub fn debug_phase(&self) -> u32

Debug: phase identifier from the lower 32 bits of the PN field. 0 = reachability, 1 = return time, 2 = throughput.

pub fn buffer(&self) -> &DynamicByteBuffer

Get the underlying buffer.

pub fn into_buffer(self) -> DynamicByteBuffer

Consume the tailer view and return the underlying buffer.

pub fn set_flags(&self, flags: PacketFlags)

pub fn set_code(&self, code: u8)

pub fn set_time(&self, time: u32)

pub fn set_packet_number_raw(&self, pn: u64)

pub fn set_packet_number(&self, timestamp: u32, incremental: u32)

Set packet number from timestamp and incremental counter.

pub fn set_packet_number_now(&self, incremental: u32)

Set packet number using current timestamp and given incremental.

pub fn set_payload_length(&self, len: u16)

pub fn set_identity(&self, identity: &T)

pub fn get_payload_length(buffer: &DynamicByteBuffer) -> u16

pub fn get_identity(buffer: &DynamicByteBuffer) -> T

Extract identity from a raw tailer buffer.

pub fn len() -> usize

Trait Implementations

impl<T: IdentityType> Clone for Tailer<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: IdentityType> Debug for Tailer<T>

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

Formats the value using the given formatter.

impl<T: IdentityType + PartialEq> PartialEq for Tailer<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.