Struct StreamByteOptions 

pub struct StreamByteOptions {
    pub topic: String,
    pub attributes: HashMap<String, String>,
    pub destination_identities: Vec<ParticipantIdentity>,
    pub id: Option<String>,
    pub mime_type: Option<String>,
    pub name: Option<String>,
    pub total_length: Option<u64>,
    pub compress: Option<bool>,
    pub sender_identity: Option<ParticipantIdentity>,
}

Options used when opening an outgoing byte data stream.

Fields

topic: String

attributes: HashMap<String, String>

destination_identities: Vec<ParticipantIdentity>

id: Option<String>

The id associated with the stream. If unspecified, a new uuid will be created and used per call.

mime_type: Option<String>

name: Option<String>

total_length: Option<u64>

compress: Option<bool>

Whether to deflate-raw compress the payload when all recipients support it. Defaults to true (compression opt-out). Ignored by the incremental stream_bytes.

sender_identity: Option<ParticipantIdentity>

The identity the stream’s packets are attributed to. If unspecified, the packets carry no explicit identity and the server attributes them to the sending participant. Only participants with the appropriate permission (e.g. agents) may impersonate another identity.

Implementations

impl StreamByteOptions

pub fn new_with_topic(topic: impl Into<String>) -> Self

pub fn with_topic(self, topic: String) -> Self

Sets the topic the stream is published to.

pub fn with_attributes(self, attributes: HashMap<String, String>) -> Self

Replaces all attributes attached to the stream.

pub fn with_attribute( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds a single attribute to the stream, overwriting any existing value for key.

pub fn with_destination_identities( self, destination_identities: Vec<ParticipantIdentity>, ) -> Self

Replaces the set of participant identities the stream is delivered to. An empty list delivers to all participants in the room.

pub fn with_destination_identity( self, identity: impl Into<ParticipantIdentity>, ) -> Self

Adds a single participant identity to the stream’s destinations.

pub fn with_id(self, id: impl Into<String>) -> Self

Sets an explicit stream id. If unset, a new uuid is generated per call.

pub fn with_mime_type(self, mime_type: impl Into<String>) -> Self

Sets the MIME type describing the stream’s payload.

pub fn with_name(self, name: impl Into<String>) -> Self

Sets a human-readable name for the stream (e.g. a file name).

pub fn with_total_length(self, total_length: u64) -> Self

Sets the total byte length of the payload, when known ahead of time.

pub fn with_compress(self, compress: bool) -> Self

Sets whether to deflate-raw compress the payload when all recipients support it. Defaults to true (compression opt-out).

pub fn with_sender_identity( self, identity: impl Into<ParticipantIdentity>, ) -> Self

Sets the identity the stream’s packets are attributed to. Only participants with the appropriate permission (e.g. agents) may impersonate another identity.

Trait Implementations

impl Clone for StreamByteOptions

fn clone(&self) -> StreamByteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamByteOptions

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

Formats the value using the given formatter.

impl Eq for StreamByteOptions

impl PartialEq for StreamByteOptions

fn eq(&self, other: &StreamByteOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamByteOptions