Struct FileConnectOptions

pub struct FileConnectOptions { /* private fields */ }

Implementations

impl FileConnectOptions

pub fn create_if_not_exists(&self) -> bool

pub fn set_create_if_not_exists(&mut self, v: bool) -> &mut Self

Default is false.

pub fn create_only(&self) -> bool

pub fn set_create_only(&mut self, v: bool) -> &mut Self

Always create the file. Fail if already exists. Default is false.

pub fn end_with_eos(&self) -> bool

pub fn set_end_with_eos(&mut self, v: bool) -> &mut Self

If true, when the producer ends, a End-of-Stream message will be written. This signals Consumers to end their streams.

Default is false.

pub fn beacon_interval(&self) -> u32

pub fn set_beacon_interval(&mut self, v: u32) -> Result<&mut Self, FileErr>

Beacon interval. Should be multiples of 1024 (1KB).

Default is crate::DEFAULT_BEACON_INTERVAL.

pub fn file_size_limit(&self) -> u64

pub fn set_file_size_limit(&mut self, v: u64) -> &mut Self

Default is crate::DEFAULT_FILE_SIZE_LIMIT.

pub fn prefetch_message(&self) -> usize

pub fn set_prefetch_message(&mut self, v: usize) -> &mut Self

Number of messages to prefetch. A larger number would lead to higher memory usage. Choose the number by considering the typical size of messages.

Default is crate::DEFAULT_PREFETCH_MESSAGE.

Trait Implementations

impl Clone for FileConnectOptions

fn clone(&self) -> FileConnectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConnectOptions for FileConnectOptions

fn set_timeout(&mut self, _: Duration) -> FileResult<&mut Self>

This parameter is ignored.

type Error = FileErr

fn timeout(&self) -> FileResult<Duration>

impl Debug for FileConnectOptions

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

Formats the value using the given formatter.

impl Default for FileConnectOptions

fn default() -> Self

Returns the “default value” for a type.