Skip to main content

JsonlReader

Struct JsonlReader 

Source
pub struct JsonlReader<T> { /* private fields */ }
Expand description

Reads JSONL records from a file, tracking the byte offset so that each poll only returns lines appended since the previous read.

Generic over any T: DeserializeOwned.

Implementations§

Source§

impl<T: DeserializeOwned> JsonlReader<T>

Source

pub fn new(path: impl Into<PathBuf>) -> Self

Create a new reader for the given path, starting at byte offset 0.

Source

pub fn with_offset(path: impl Into<PathBuf>, offset: u64) -> Self

Create a new reader starting at the given byte offset.

Useful when restoring from persisted state — you can resume reading from where you left off without replaying old messages.

Source

pub fn offset(&self) -> u64

Return the current byte offset.

Source

pub fn set_offset(&mut self, offset: u64)

Set the byte offset (e.g. when restoring from persisted state).

Source

pub fn skip_to_end(&mut self) -> Result<u64>

Skip to the end of the file so that subsequent polls only see new data.

Returns the new offset, or 0 if the file does not exist.

Source

pub fn poll(&mut self) -> Result<Vec<T>>

Read any new lines appended since the last poll.

Returns a vector of successfully deserialized records. Malformed lines are silently skipped (the offset still advances past them).

Trait Implementations§

Source§

impl<T: Debug> Debug for JsonlReader<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for JsonlReader<T>

§

impl<T> RefUnwindSafe for JsonlReader<T>
where T: RefUnwindSafe,

§

impl<T> Send for JsonlReader<T>
where T: Send,

§

impl<T> Sync for JsonlReader<T>
where T: Sync,

§

impl<T> Unpin for JsonlReader<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for JsonlReader<T>

§

impl<T> UnwindSafe for JsonlReader<T>
where T: UnwindSafe,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.