danvics/oxipng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add doc comments for from_path

Browse source
This commit is contained in:
Andrew 2023-09-20 19:24:19 +12:00
parent dcc6b16b1a
commit 27262d4582
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/lib.rs
View file

@ -91,6 +91,9 @@ pub enum OutFile {
} }
impl OutFile { impl OutFile {
/// Construct a new `OutFile` with the given path.
///
/// This is a convenience method for `OutFile::Path { path: Some(path), preserve_attrs: false }`.
pub fn from_path(path: PathBuf) -> Self { pub fn from_path(path: PathBuf) -> Self {
OutFile::Path { OutFile::Path {
path: Some(path), path: Some(path),