diff options
| author | Mason Reed <mason@vector35.com> | 2026-02-17 20:16:39 -0800 |
|---|---|---|
| committer | Mason Reed <35282038+emesare@users.noreply.github.com> | 2026-02-23 00:09:44 -0800 |
| commit | 837f8590be80b7c98162e70e4f0c1814b83e9d7b (patch) | |
| tree | c3355c31839acf9cbe3148579be1a0685ddce91f /rust/src/file_metadata.rs | |
| parent | b765ffd736ecbfbb7c19b7e166a021ac46a9eeb8 (diff) | |
[Rust] Misc documentation cleanup
Diffstat (limited to 'rust/src/file_metadata.rs')
| -rw-r--r-- | rust/src/file_metadata.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/rust/src/file_metadata.rs b/rust/src/file_metadata.rs index f6427750..bb783158 100644 --- a/rust/src/file_metadata.rs +++ b/rust/src/file_metadata.rs @@ -122,6 +122,10 @@ impl FileMetadata { /// /// It may not be present if the BNDB was saved without it or cleared via [`FileMetadata::clear_original_file_path`]. /// + /// If this [`FileMetadata`] is a database within a project, it may not have a "consumable" original + /// file path. Instead, this might return the path to the on disk file path of the project file that + /// this database was created from, for projects you should query through [`FileMetadata::project_file`]. + /// /// Only prefer this over [`FileMetadata::file_path`] if you require the original binary location. pub fn original_file_path(&self) -> Option<PathBuf> { let raw_name = unsafe { |