MessageCompressor

Struct MessageCompressor 

Source
pub struct MessageCompressor {
    CompressionLevel: u32,
    BatchSize: usize,
}
Expand description

Message compression utility for optimizing IPC message transfer

This structure provides Gzip-based compression to reduce the size of IPC messages, improving transfer speed and reducing bandwidth usage.

§Compression Flow

Multiple TauriIPCMessage
    |
    | 1. Serialize to JSON
    v
Serialized JSON bytes
    |
    | 2. Compress with Gzip
    v
Compressed bytes (smaller)
    |
    | 3. Base64 encode for transport
    v
Base64 string (sendable via IPC)

§Decompression Flow

Base64 string (received via IPC)
    |
    | 1. Base64 decode
    v
Compressed bytes
    |
    | 2. Decompress with Gzip
    v
Serialized JSON bytes
    |
    | 3. Deserialize to TauriIPCMessage[]
    v
Multiple TauriIPCMessage

§Compression Levels

Compression levels range from 0 (fastest, no compression) to 9 (slowest, best compression). The recommended level is 6 for a good balance.

LevelSpeedRatioUse Case
0Fastest1:1Testing/debugging
1-3Fast2:1-3:1Real-time systems
4-6Medium3:1-5:1General use
7-9Slow5:1-7:1Bandwidth-constrained

§Example Usage

let compressor = MessageCompressor::new(6, 10);

// Compress messages
let messages = vec![message1, message2, message3];
let compressed = compressor.compress_messages(messages)?;

// Decompress messages
let decompressed = compressor.decompress_messages(&compressed)?;

Fields§

§CompressionLevel: u32

Gzip compression level (0-9, where 0 is no compression)

§BatchSize: usize

Minimum number of messages required for batch processing

Implementations§

Source§

impl MessageCompressor

Source

pub fn new(CompressionLevel: u32, BatchSize: usize) -> Self

Create a new message compressor with specified parameters

§Parameters
  • CompressionLevel: Gzip compression level (0-9, default 6)
  • BatchSize: Minimum messages for batch processing (default 10)
§Example
let compressor = MessageCompressor::new(6, 10);
Source

pub fn compress_messages( &self, Messages: Vec<TauriIPCMessage>, ) -> Result<Vec<u8>, String>

Compress messages using Gzip for efficient transfer

This method serializes multiple messages to JSON and compresses them using Gzip, significantly reducing the payload size.

§Parameters
  • Messages: Vector of TauriIPCMessage to compress
§Returns
  • Ok(Vec<u8>): Compressed message data
  • Err(String): Error message if compression fails
§Example
let messages = vec![msg1, msg2, msg3];
let compressed = compressor.compress_messages(messages)?;
Source

pub fn decompress_messages( &self, CompressedData: &[u8], ) -> Result<Vec<TauriIPCMessage>, String>

Decompress messages from compressed data

This method decompresses Gzip-compressed data and deserializes it back into TauriIPCMessage objects.

§Parameters
  • CompressedData: Compressed message data
§Returns
  • Ok(Vec<TauriIPCMessage>): Decompressed messages
  • Err(String): Error message if decompression fails
§Example
let messages = compressor.decompress_messages(&compressed_data)?;
Source

pub fn should_batch(&self, MessagesCount: usize) -> bool

Check if messages should be batched for compression

This method determines if the number of messages meets the threshold for batch compression.

§Parameters
  • MessagesCount: Number of messages to check
§Returns
  • true: Should batch (meets minimum threshold)
  • false: Should not batch (below threshold)
§Example
if compressor.should_batch(messages.len()) {
    // Batch compress
} else {
    // Send individually
}
Source

pub fn compression_level(&self) -> u32

Get the compression level

Source

pub fn batch_size(&self) -> usize

Get the batch size threshold

Source

pub fn default() -> Self

Create a compressor with default settings (level 6, batch size 10)

Source

pub fn fast() -> Self

Create a fast compressor (level 3, batch size 5)

Source

pub fn max() -> Self

Create a maximum compression compressor (level 9, batch size 20)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,