Struct creek_core::write::WriteStreamOptions

pub struct WriteStreamOptions<E: Encoder> {
    pub additional_opts: E::AdditionalOpts,
    pub num_write_blocks: usize,
    pub block_size: usize,
    pub server_msg_channel_size: Option<usize>,
}

Options for a write stream.

Fields

additional_opts: E::AdditionalOpts

Any additional encoder-specific options.

num_write_blocks: usize

The number of write blocks to reserve. This must be sufficiently large to ensure there are enough write blocks for the client in the worst case write latency scenerio.

This should be left alone unless you know what you are doing.

block_size: usize

The number of frames in a write block.

This should be left alone unless you know what you are doing.

server_msg_channel_size: Option<usize>

The size of the realtime ring buffer that sends data to and from the stream the the internal IO server. This must be sufficiently large enough to avoid stalling the channels.

Set this to None to automatically find a generous size based on the other write options. This should be left as None unless you know what you are doing.

The default is None.

Trait Implementations

impl<E: Clone + Encoder> Clone for WriteStreamOptions<E>

where E::AdditionalOpts: Clone,

fn clone(&self) -> WriteStreamOptions<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Encoder> Debug for WriteStreamOptions<E>

where E::AdditionalOpts: Debug,

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

Formats the value using the given formatter.

impl<E: Encoder> Default for WriteStreamOptions<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Copy + Encoder> Copy for WriteStreamOptions<E>

where E::AdditionalOpts: Copy,