aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2019-11-02 05:39:21 +0100
committerTeddy Wing2019-11-02 05:39:21 +0100
commit99189e55a2fe4b14e269015f73b8d30a8e45ef2c (patch)
tree168d630f35a886504bf1e1369be1c3cbbef8ca66
parent523170630fd8e9ba695f4167d132a8812d814a1e (diff)
downloadpdf-urls-99189e55a2fe4b14e269015f73b8d30a8e45ef2c.tar.bz2
get_urls_from_pdf: Add a short doc string
-rw-r--r--src/lib.rs1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index d84ecea..227911a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -11,6 +11,7 @@ use lopdf::{Document, Object};
use errors::Result;
+/// Given a file path to a PDF, return a Vec of all URLs in the document.
pub fn get_urls_from_pdf<P: AsRef<Path>>(path: P) -> Result<Vec<String>> {
let doc = Document::load(path)?;