crepererum commented on code in PR #5020:
URL: https://github.com/apache/arrow-rs/pull/5020#discussion_r1379824567
##########
object_store/src/local.rs:
##########
@@ -176,6 +181,30 @@ impl From<Error> for super::Error {
/// [file URI]: https://en.wikipedia.org/wiki/File_URI_scheme
/// [RFC 3986]: https://www.rfc-editor.org/rfc/rfc3986
///
+/// # Path Semantics
+///
+/// [`LocalFileSystem`] will expose the path semantics of the underlying
filesystem, which may
+/// have additional restrictions beyond those enforced by [`Path`].
+///
+/// For example:
+///
+/// * Windows forbids certain filenames, e.g. `COM0`,
+/// * Windows forbids folders with trailing `.`
+/// * Windows forbids certain ASCII characters, e.g. `<` or `|`
+/// * OS X forbids filenames containing `:`
+/// * Leading `-` are discouraged on Unix systems where they may be
interpreted as CLI flags
+/// * Filesystems may have restrictions on the maximum path or path segment
length
+/// * Filesystem support for non-ASCII characters is inconsistent
Review Comment:
FWIW: what we could do for FS (although that wouldn't be backwards
compatible) is to percent-encode the path segments.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
