Struct limlog::TopicBuilder

pub struct TopicBuilder { /* private fields */ }

Builds Topic with custom configuration values.

Methods can be chained in order to set the configuration values. The Topic is constructed by calling TopicBuilder::build.

New instances of TopicBuilder are obtained via TopicBuilder::new, TopicBuilder::new_with_dir or Topic::builder.

let _topic = Topic::builder("test")
    .unwrap()
    .with_log_size(1 << 32)
    .with_index_size(1 << 24)
    .with_channel_size(16)
    .build()
    .await
    .unwrap();

Implementations

impl TopicBuilder

pub fn new(topic: impl Into<String>) -> Result<Self>

Returns a new TopicBuilder with topic and current working directory.

Configuration methods can be chained on the return value.

pub fn new_with_dir( topic: impl Into<String>, dir: impl Into<PathBuf> ) -> Result<Self>

Returns a new TopicBuilder with topic and dir.

Configuration methods can be chained on the return value.

pub fn with_directory(self, dir: impl Into<PathBuf>) -> Result<Self>

Specify the topic working directory.

pub const fn with_log_size(self, log_size: u64) -> Self

Set log file max size.

pub const fn with_index_size(self, index_size: u64) -> Self

Set index file max size.

pub const fn with_channel_size(self, channel_size: u32) -> Self

Set channel max size.

The Writer will block if the channel is full until write request is consumed.

pub fn topic_dir(&self) -> PathBuf

Returns the topic directory where the .limlog and .idx files placed.

pub async fn build(self) -> Result<Topic>

Construct a Topic instant if configurations is valid.

Trait Implementations

impl Clone for TopicBuilder

fn clone(&self) -> TopicBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicBuilder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TopicBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TopicBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<TopicBuilder> for TopicBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TopicBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TopicBuilder

impl StructuralEq for TopicBuilder

impl StructuralPartialEq for TopicBuilder

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:72 bytes