DevComp/zip-rs-wasm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: deprecate Path handling methods

Browse source 
These methods were implemented in a non-intuitive way that could easily
lead to bugs. They may be replaced in a future release
This commit is contained in:
Marli Frost 2020-08-19 13:23:00 +01:00
parent df8f377f92
commit f86c310fdc
No known key found for this signature in database
GPG key ID: CB0BEA7CF9BD1245
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/write.rs
View file

@ -290,6 +290,10 @@ impl<W: Write + io::Seek> ZipWriter<W> {
/// ///
/// This function ensures that the '/' path seperator is used. It also ignores all non 'Normal' /// This function ensures that the '/' path seperator is used. It also ignores all non 'Normal'
/// Components, such as a starting '/' or '..' and '.'. /// Components, such as a starting '/' or '..' and '.'.
#[deprecated(
since = "0.5.7",
note = "by stripping `..`s from the path, the meaning of paths can change. Use `start_file` instead."
)]
pub fn start_file_from_path( pub fn start_file_from_path(
&mut self, &mut self,
path: &std::path::Path, path: &std::path::Path,
@ -327,6 +331,10 @@ impl<W: Write + io::Seek> ZipWriter<W> {
/// ///
/// This function ensures that the '/' path seperator is used. It also ignores all non 'Normal' /// This function ensures that the '/' path seperator is used. It also ignores all non 'Normal'
/// Components, such as a starting '/' or '..' and '.'. /// Components, such as a starting '/' or '..' and '.'.
#[deprecated(
since = "0.5.7",
note = "by stripping `..`s from the path, the meaning of paths can change. Use `add_directory` instead."
)]
pub fn add_directory_from_path( pub fn add_directory_from_path(
&mut self, &mut self,
path: &std::path::Path, path: &std::path::Path,