Skip to main content

NdjsonFramer

Struct NdjsonFramer 

Source
pub struct NdjsonFramer { /* private fields */ }
Expand description

Newline-delimited record framing (NDJSON / JSON Lines) as a streaming RecordFramer.

The framer knows nothing about JSON beyond the newline convention NDJSON guarantees — a JSON document never contains an unescaped newline, so every \n is an unambiguous record boundary.

Framing rules (pinned — changing any of them changes record indexes, which is a resume-compatibility break for sources that checkpoint by index):

  • Records are split on \n. Exactly one trailing \r is stripped (CRLF input); nothing else is trimmed.
  • Lines that are empty or all-ASCII-whitespace are skipped and do not consume a record index.
  • An unterminated final line (no closing \n) is a record.

Implementations§

Source§

impl NdjsonFramer

Source

pub fn new(max_record_bytes: usize) -> NdjsonFramer

A line framer bounding each record at max_record_bytes decoded bytes.

Trait Implementations§

Source§

impl Debug for NdjsonFramer

Source§

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

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

impl RecordFramer for NdjsonFramer

Source§

fn push(&mut self, bytes: &[u8]) -> Result<()>

Feed the next run of decoded bytes.
Source§

fn finish(&mut self) -> Result<()>

End of the stream/object: complete an unterminated final record if the format allows one, and validate any end-of-stream structure.
Source§

fn pop(&mut self) -> Option<Vec<u8>>

Pop the next completed record, in stream order.
Source§

fn decoded_bytes(&self) -> u64

Total decoded bytes fed so far (for metrics).

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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