Struct WebSocketSink 

pub(crate) struct WebSocketSink {
    pub(crate) socket: WebSocket,
}

WebSocket implementation of ExportSink.

Control frames go out as JSON text messages and CSV chunks as binary messages.

Fields

socket: WebSocket

Upgraded client connection.

Implementations

impl WebSocketSink

pub(crate) fn new(socket: WebSocket) -> Self

Wraps a WebSocket as an export sink.

Arguments

• socket - Upgraded client connection.

pub(crate) async fn send_close(&mut self) -> Result<()>

Sends a WebSocket close frame.

Errors

Returns an error if the send fails.

Trait Implementations

impl ExportSink for WebSocketSink

fn send_meta<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, file_name: &'life1 str, content_type: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Sends metadata as a text JSON WebSocket message (MetaFrame).

fn send_chunk<'life0, 'async_trait>( &'life0 mut self, data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a CSV chunk as a binary WebSocket message.

fn send_summary<'life0, 'life1, 'async_trait>( &'life0 mut self, bytes_sent: usize, missing_channels: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends byte count and missing channels as a text JSON message (SummaryFrame).

fn send_complete<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends {"type":"complete"} as a text message.

fn send_error<'life0, 'life1, 'async_trait>( &'life0 mut self, message: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a text JSON error message (ErrorFrame).