Struct SendTextOptions 

#[non_exhaustive]
pub struct SendTextOptions {
    pub topic: String,
    pub attributes: HashMap<String, String>,
    pub destination_identities: Vec<ParticipantIdentity>,
    pub id: Option<String>,
    pub operation_type: Option<OperationType>,
    pub version: Option<i32>,
    pub reply_to_stream_id: Option<String>,
    pub attached_stream_ids: Vec<String>,
    pub generated: Option<bool>,
    pub sender_identity: Option<ParticipantIdentity>,
    pub compress: Option<bool>,
    pub on_progress: Option<StreamProgressCallback>,
}

Options for send_text. Progress is reported once after the complete send is acknowledged.

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.

operation_type: Option<OperationType>

Operation this text stream represents.

version: Option<i32>

Version used to order updates to the same content.

reply_to_stream_id: Option<String>

Id of the stream this text replies to.

attached_stream_ids: Vec<String>

Ids of streams attached to this text.

generated: Option<bool>

Whether the text was machine-generated.

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

compress: Option<bool>

Whether to deflate-raw compress when all recipients support it. Defaults to true.

on_progress: Option<StreamProgressCallback>

Reports payload byte length once after the complete send is acknowledged.

Implementations

impl SendTextOptions

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_operation_type(self, operation_type: OperationType) -> Self

Sets the operation this text stream represents (e.g. create or update).

pub fn with_version(self, version: i32) -> Self

Sets the version of the text, used to order updates to the same content.

pub fn with_reply_to_stream_id( self, reply_to_stream_id: impl Into<String>, ) -> Self

Sets the id of the stream this text is a reply to.

pub fn with_attached_stream_ids(self, attached_stream_ids: Vec<String>) -> Self

Replaces the set of stream ids attached to this text (e.g. referenced files).

pub fn with_attached_stream_id( self, attached_stream_id: impl Into<String>, ) -> Self

Adds a single attached stream id to this text.

pub fn with_generated(self, generated: bool) -> Self

Sets whether the text was machine-generated (e.g. by an agent).

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

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

pub fn with_on_progress( self, callback: impl Fn(StreamProgress) + Send + Sync + 'static, ) -> Self

Sets the progress callback; see Self::on_progress for reporting semantics.

Trait Implementations

impl Clone for SendTextOptions

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 SendTextOptions

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

Formats the value using the given formatter.

impl Eq for SendTextOptions

impl PartialEq for SendTextOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SendTextOptions