Skip to content

amachang/path_to_unicode_filename

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Workflow Status (with event) Codecov docs.rs Crates.io Crates.io

path_to_unicode_filename

The library encodes file path separators and common directory names, producing a reversible unicode string that can be used as a filename. It's useful in the case when you want to extract data or features from any file and store them in a specific directory.

It replaces path chars as below:

  • chars \/:*?"<>| be replaced to full width alternative chars of unicode.
  • U+0000 be replaced to .
  • a common directory, like home, documents, pictures, etc are replaced to a OS icon (🍎, 🐧, etc) and a directory icon (🏠, 📄, 🎨, etc).
  • chars replacements for others be replaced to twice-sequential chars itself

Examples

use path_to_unicode_filename::*;

// make a filename
assert_eq!(to_filename("/tmp/file.txt"), Ok("/tmp/file.txt".into()));
assert_eq!(to_filename("C:\\Users\\alice\\file.txt"), Ok("💠🏠alice\file.txt".into()));
assert_eq!(to_filename("/Users/alice/Documents/file.txt"), Ok("🍎📄alice/file.txt".into()));

// restore the filename to the original path
assert_eq!(to_path("/var/log/file.txt"), Ok("/var/log/file.txt".into()));
assert_eq!(to_path("🐧🥞sdcard001/file.txt"), Ok("/media/sdcard001/file.txt".into()));
assert_eq!(to_path("🍎🎨bob/file.png"), Ok("/Users/bob/Pictures/file.png".into()));

License: MIT OR Apache-2.0

About

No description, website, or topics provided.

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages