Struct FileConfig 

#[non_exhaustive]
pub struct FileConfig {
    pub src: FileSrc,
    pub bus: Option<EventBus>,
    pub cancel: Option<CancellationToken>,
    pub downloader: Option<Downloader>,
    pub headers: Option<Headers>,
    pub look_ahead_bytes: Option<u64>,
    pub name: Option<String>,
    pub store: StoreOptions,
    pub event_channel_capacity: usize,
}

Configuration for file streaming.

Used with Stream::<File>::new(config).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

src: FileSrc

File source (remote URL or local path).

bus: Option<EventBus>

Event bus (optional - if not provided, one is created internally).

cancel: Option<CancellationToken>

Cancellation token for graceful shutdown.

downloader: Option<Downloader>

Shared downloader (created lazily if not provided).

headers: Option<Headers>

Additional HTTP headers to include in all requests.

look_ahead_bytes: Option<u64>

Max bytes the downloader may be ahead of the reader before it pauses.

name: Option<String>

Optional name for cache disambiguation.

store: StoreOptions

Storage configuration.

event_channel_capacity: usize

Event bus channel capacity (used when bus is not provided).

Implementations

impl FileConfig

pub fn builder() -> FileConfigBuilder

Create an instance of FileConfig using the builder syntax

impl FileConfig

pub fn new(src: FileSrc) -> Self

Create new file config with source.

pub fn for_src(src: FileSrc) -> FileConfigBuilder<SetSrc>

Chainable counterpart to FileConfig::new.

Trait Implementations

impl Clone for FileConfig

fn clone(&self) -> FileConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileConfig

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

Formats the value using the given formatter.

impl Default for FileConfig

fn default() -> Self

Returns the “default value” for a type.