Struct limlog::Topic

pub struct Topic { /* private fields */ }

The topic which is used to read and write logs. Background task will keep running even if this struct is dropped. To stop the task, call stop or abort.

Implementations

impl Topic

pub fn builder(topic: impl Into<String>) -> Result<TopicBuilder>

Returns a new TopicBuilder with topic and current working directory.

Configuration methods can be chained on the return value.

pub async fn new(conf: TopicBuilder) -> Result<Self>

Create a new Topic with TopicBuilder.

Equivalent to TopicBuilder::build.

pub async fn write_one(&self, log: Log) -> Result<()>

Write a Log asynchronous.

pub fn writer(&self) -> Writer

Returns the Writer to write logs.

let w = topic.writer();

loop {
    w.write("hello").await.unwrap();
}

pub fn reader(&self) -> Reader

Returns the Reader to read logs.

use futures::StreamExt;

let r = topic.reader();
let log = r.next().await.unwrap().unwrap();

pub fn reader_at(&self, read_at: usize) -> Result<Reader>

Create a Reader by given offset.

pub fn config(&self) -> &TopicBuilder

Returns the topic configurations.

pub fn stop(&self)

Issue a stop signal to the background task. This will return immediately but the task can take time to finish. Use with join to gracefully shutdown.

pub fn stopped(&self) -> bool

Check if the background task is finished.

pub fn abort(&self)

Abort background task.

pub async fn join(self) -> Result<()>

Wait for background task to complete. This can be used with stop to gracefully shutdown.

Panics

Panics if the background task panicked.

Trait Implementations

impl Debug for Topic

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size:24 bytes