Struct sea_streamer_file::FileConnectOptions

source ยท
pub struct FileConnectOptions { /* private fields */ }

Implementationsยง

sourceยง

impl FileConnectOptions

source

pub fn create_if_not_exists(&self) -> bool

source

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

Default is false.

source

pub fn create_only(&self) -> bool

source

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

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

source

pub fn end_with_eos(&self) -> bool

source

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.

source

pub fn beacon_interval(&self) -> u32

source

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.

source

pub fn file_size_limit(&self) -> u64

source

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

source

pub fn prefetch_message(&self) -> usize

source

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ยง

sourceยง

impl Clone for FileConnectOptions

sourceยง

fn clone(&self) -> FileConnectOptions

Returns a copy of the value. Read more
1.0.0 ยท sourceยง

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

Performs copy-assignment from source. Read more
sourceยง

impl ConnectOptions for FileConnectOptions

sourceยง

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

This parameter is ignored.

ยง

type Error = FileErr

sourceยง

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

sourceยง

impl Debug for FileConnectOptions

sourceยง

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

Formats the value using the given formatter. Read more
sourceยง

impl Default for FileConnectOptions

sourceยง

fn default() -> Self

Returns the โ€œdefault valueโ€ for a type. Read more

Auto Trait Implementationsยง

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> ToOwned for T
where T: Clone,

ยง

type Owned = T

The resulting type after obtaining ownership.
sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

ยง

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

ยง

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.