gendx/lzma-rs

add `xz_decompress_with_options` API

Open

#110 opened on May 5, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (37 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (151 stars)
PR merge metrics
 (PR metrics pending)

Description

Problem

xz_decompress reads the entire .xz file in one call. The entire file is stored in memory. Decompressing large files can lead to Out Of Memory errors.

Solution

Provide xz_decompress_with_options, similar to other _with_options API functions. Notably, this would allow passing an Options with a set memlimit. Then the user need not store the entire file in memory.

Similar to #49

Contributor guide

Research direction
Examine the existing xz decompress implementation and the Options struct to add a new function xz decompress with options that accepts Options and respects the memory limit.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60