Struct NewlineFramer 

pub struct NewlineFramer { /* private fields */ }

Frames incoming data by splitting on newlines.

Only the newline character (0x0A, also known as “line feed”) is used to split the payload into frames. If there are carriage return characters (0x0D) in the payload, they will be included in the resulting frames.

Implementations

impl NewlineFramer

pub fn required_on_eof(self, require: bool) -> Self

Whether or not the delimiter is required when EOF has been reached.

This controls whether or not the frames must always be suffixed by the delimiter character. In some cases, a delimiter is purely for separating multiple frames within a single payload, and when the final payload is sent, it may not include the delimiter at the end.

If the framing configuration requires the delimiter to always be present, then set this to true.

Defaults to false.

Trait Implementations

impl Default for NewlineFramer

fn default() -> NewlineFramer

Returns the “default value” for a type.

impl Framer for NewlineFramer

fn next_frame<'a, B: ReadIoBuffer>( &mut self, buf: &mut B, is_eof: bool, ) -> Result<Option<Bytes>, FramingError>

Attempt to extract the next frame from the buffer.