Struct StreamByteOptions 

#[non_exhaustive]
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 sender_identity: Option<ParticipantIdentity>,
    pub total_length: Option<u64>,
}

Options for stream_bytes, which never compresses or inlines content.

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.

topic: String

Topic the stream is published to.

attributes: HashMap<String, String>

Attributes attached to the stream.

destination_identities: Vec<ParticipantIdentity>

Recipients; an empty list delivers to all participants.

id: Option<String>

Explicit stream id, or a new UUID per call when unspecified.

mime_type: Option<String>

MIME type describing the payload.

name: Option<String>

Human-readable name for the stream.

sender_identity: Option<ParticipantIdentity>

Identity attributed to the packets, or the sending participant when unspecified. Impersonating another identity requires the appropriate permission (e.g. agents).

total_length: Option<u64>

Declared total byte length, when known. The receiver fails the stream on a mismatch.

Implementations

impl StreamByteOptions

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

Creates options for the given topic. Use the with_* setters to customize them.

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

Sets the topic the stream is published to, accepting any value convertible to String.

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_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.

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.

Trait Implementations

impl Clone for StreamByteOptions

fn clone(&self) -> Self

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: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamByteOptions