Skip to main content

DiskBufferBuilder

Struct DiskBufferBuilder 

Source
pub struct DiskBufferBuilder<I1, S: State = Empty>
where I1: Into<PathBuf>,
{ /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<I1, S: State> DiskBufferBuilder<I1, S>
where I1: Into<PathBuf>,

Source

pub fn build(self) -> Result<SegmentWriter<Disk>>
where S: IsComplete,

Finishes building and performs the requested action.

Source

pub fn base_path(self, value: I1) -> DiskBufferBuilder<I1, SetBasePath<S>>
where S::BasePath: IsUnset,

Required.

Source

pub fn max_file_size( self, value: u64, ) -> DiskBufferBuilder<I1, SetMaxFileSize<S>>
where S::MaxFileSize: IsUnset,

Optional (Some / Option setters). Per-file rotation threshold in bytes. Defaults to min(100 MiB, max_total_size / 4) when not set.

Source

pub fn maybe_max_file_size( self, value: Option<u64>, ) -> DiskBufferBuilder<I1, SetMaxFileSize<S>>
where S::MaxFileSize: IsUnset,

Optional (Some / Option setters). Per-file rotation threshold in bytes. Defaults to min(100 MiB, max_total_size / 4) when not set.

Source

pub fn max_total_size( self, value: u64, ) -> DiskBufferBuilder<I1, SetMaxTotalSize<S>>
where S::MaxTotalSize: IsUnset,

Required.

Source

pub fn rotation_period( self, value: Duration, ) -> DiskBufferBuilder<I1, SetRotationPeriod<S>>
where S::RotationPeriod: IsUnset,

Optional (Some / Option setters). How often to rotate, measured in monotonic time since the writer (or the previous rotation) started. Defaults to 60 seconds. Duration::MAX disables time-based rotation.

Source

pub fn maybe_rotation_period( self, value: Option<Duration>, ) -> DiskBufferBuilder<I1, SetRotationPeriod<S>>
where S::RotationPeriod: IsUnset,

Optional (Some / Option setters). How often to rotate, measured in monotonic time since the writer (or the previous rotation) started. Defaults to 60 seconds. Duration::MAX disables time-based rotation.

Source

pub fn segment_metadata( self, value: Vec<(String, String)>, ) -> DiskBufferBuilder<I1, SetSegmentMetadata<S>>
where S::SegmentMetadata: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_segment_metadata( self, value: Option<Vec<(String, String)>>, ) -> DiskBufferBuilder<I1, SetSegmentMetadata<S>>
where S::SegmentMetadata: IsUnset,

Optional (Some / Option setters).

Auto Trait Implementations§

§

impl<I1, S> Freeze for DiskBufferBuilder<I1, S>
where I1: Freeze,

§

impl<I1, S> RefUnwindSafe for DiskBufferBuilder<I1, S>
where I1: RefUnwindSafe,

§

impl<I1, S> Send for DiskBufferBuilder<I1, S>
where I1: Send,

§

impl<I1, S> Sync for DiskBufferBuilder<I1, S>
where I1: Sync,

§

impl<I1, S> Unpin for DiskBufferBuilder<I1, S>
where I1: Unpin,

§

impl<I1, S> UnsafeUnpin for DiskBufferBuilder<I1, S>
where I1: UnsafeUnpin,

§

impl<I1, S> UnwindSafe for DiskBufferBuilder<I1, S>
where I1: 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

Source§

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer
Source§

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

Source§

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer
Source§

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

Source§

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer
Source§

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

Source§

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer
Source§

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

Source§

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer
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