Renamed uncompress_file function to uncompress_data

CHANGES.md

@@ -4,7 +4,7 @@
 
 ### Added
 
-* `uncompress_file` and `uncompress_archive_file`, on success, now return the ammount of bytes they have uncompressed [#16]
+* `uncompress_data` (previously `uncompress_file`) and `uncompress_archive_file`, on success, now return the ammount of bytes they have uncompressed [#16]
 
 [#16]: https://github.com/OSSystems/compress-tools-rs/pull/16
 
@@ -14,7 +14,10 @@
   * `Read` and `Write` arguments are no longer required to be a mutable reference,
     which allows for more tyes to be used, as `&mut [u8]`
 
+* Renamed `uncompress_file` function to `uncompress_data` [#17]
+
 [#14]: https://github.com/OSSystems/compress-tools-rs/pull/14
+[#17]: https://github.com/OSSystems/compress-tools-rs/pull/17
 
 ## [0.3.1] 2020-04-14
 

examples/uncompress.rs

@@ -76,7 +76,7 @@ fn main() -> compress_tools::Result<()> {
             let mut source = std::fs::File::open(input.source_path)?;
             let mut target = std::fs::File::open(input.target_path)?;
 
-            uncompress_file(&mut source, &mut target)?;
+            uncompress_data(&mut source, &mut target)?;
         }
         CmdLine::UncompressArchiveFile(input) => {
             let mut source = std::fs::File::open(input.source_path)?;

src/lib.rs

@@ -76,7 +76,7 @@ enum Mode {
 /// let mut source = File::open("file.txt.gz")?;
 /// let mut target = Vec::default();
 ///
-/// uncompress_file(&mut source, &mut target)?;
+/// uncompress_data(&mut source, &mut target)?;
 /// # Ok(())
 /// # }
 /// ```
@@ -90,11 +90,11 @@ enum Mode {
 /// let mut source = File::open("file.txt.gz")?;
 /// let mut target = [0 as u8;313];
 ///
-/// uncompress_file(&mut source, &mut target as &mut [u8])?;
+/// uncompress_data(&mut source, &mut target as &mut [u8])?;
 /// # Ok(())
 /// # }
 /// ```
-pub fn uncompress_file<R, W>(source: R, target: W) -> Result<usize>
+pub fn uncompress_data<R, W>(source: R, target: W) -> Result<usize>
 where
     R: Read,
     W: Write,

tests/integration_test.rs

@@ -9,7 +9,7 @@ fn get_compressed_file_content() {
     let mut source = std::fs::File::open("tests/fixtures/file.txt.gz").unwrap();
     let mut target = Vec::default();
 
-    let written = uncompress_file(&mut source, &mut target).expect("Failed to uncompress the file");
+    let written = uncompress_data(&mut source, &mut target).expect("Failed to uncompress the file");
     assert_eq!(
         String::from_utf8_lossy(&target),
         "some_file_content\n",