Skip to main content

Optimizer

Struct Optimizer 

Source
pub struct Optimizer {
    pub speed_limit: Option<u64>,
    /* private fields */
}
Expand description

Download optimizer for compression, caching, and speed limiting.

The Optimizer manages download performance features:

  • Compression: Reduces storage size using configurable algorithms
  • Caching: Stores files locally to avoid re-downloading
  • Speed limits: Controls maximum download speed

§Compression Levels

LevelAlgorithmSpeedRatio
1-3GzipFastModerate
4-6LZ4BalancedGood
7-9BrotliSlowBest

§Example

use kget::{Optimizer, Config};

// From config
let config = Config::default();
let optimizer = Optimizer::from_config(config.optimization);

// Or with defaults
let optimizer = Optimizer::new();

Fields§

§speed_limit: Option<u64>

Speed limit in bytes per second (None = unlimited)

Implementations§

Source§

impl Optimizer

Source

pub fn from_config(config: OptimizationConfig) -> Self

Create a new Optimizer with the provided configuration.

§Arguments
  • config - Optimization configuration settings
§Example
use kget::{Optimizer, Config};

let config = Config::default();
let optimizer = Optimizer::from_config(config.optimization);
Source

pub fn compress(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn Error>>

Compress data using the configured algorithm.

The algorithm is selected based on compression_level:

  • Levels 1-3: Gzip (fast)
  • Levels 4-6: LZ4 (balanced)
  • Levels 7-9: Brotli (high compression)

Returns the original data unchanged if compression is disabled.

Source

pub fn decompress(&self, data: &[u8]) -> Result<Vec<u8>, Box<dyn Error>>

Decompress data using the appropriate algorithm based on the file header

Supports Gzip, Brotli, and LZ4

Source

pub fn get_cached_file( &self, url: &str, ) -> Result<Option<Vec<u8>>, Box<dyn Error>>

Retrieve a file from the cache if it exists.

§Arguments
  • url - The URL that was used to download the file
§Returns
  • Ok(Some(data)) if the file exists in cache
  • Ok(None) if caching is disabled or file doesn’t exist
  • Err on I/O errors
Source

pub fn cache_file(&self, url: &str, data: &[u8]) -> Result<(), Box<dyn Error>>

Store a file in the cache

Does nothing if caching is disabled

Source

pub fn get_peer_limit(&self) -> usize

Get the peer connection limit for torrent downloads.

Uses the speed limit as a proxy for connection capacity. Returns 50 if no speed limit is set.

Source

pub fn is_compression_enabled(&self) -> bool

Check if compression is enabled.

Source

pub fn new() -> Self

Create a new Optimizer with default settings.

Equivalent to Optimizer::default().

Trait Implementations§

Source§

impl Clone for Optimizer

Source§

fn clone(&self) -> Optimizer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Optimizer

Source§

fn default() -> Self

Create an Optimizer with sensible defaults:

  • Compression enabled at level 6 (LZ4)
  • Caching enabled in ~/.cache/kget
  • No speed limit
  • 4 max connections

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

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
Source§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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