Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update documentation to be clearer on pseudo-directory pitfalls #980

Merged
merged 4 commits into from
Aug 9, 2022
Merged

docs: Update documentation to be clearer on pseudo-directory pitfalls #980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
10b83d7
docs: Update documentation with additional information on using psedu…
sydney-munro Aug 8, 2022
01117b3
update readme
sydney-munro Aug 8, 2022
a5d45ca
Linter changes
sydney-munro Aug 9, 2022
17008ca
PR suggestion
sydney-munro Aug 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions .readme-partials.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ custom_content: |
always be assumed to exist, without performing any I/O. Paths without the trailing
slash will result in an I/O operation to check a file is present in that "directory".
This allows you to do path manipulation in the same manner as you would with the normal UNIX file
system implementation. You can disable this feature with
`CloudStorageConfiguration.usePseudoDirectories()`.
system implementation. Using this feature with buckets or "directory" paths that do not exist
is not recommended, as at the time I/O is performed the failure may not be handled gracefully.
You can disable this feature with `CloudStorageConfiguration.usePseudoDirectories()`.

#### Complete source code

Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,9 @@ path that includes a trailing slash, will be considered a directory. It will
always be assumed to exist, without performing any I/O. Paths without the trailing
slash will result in an I/O operation to check a file is present in that "directory".
This allows you to do path manipulation in the same manner as you would with the normal UNIX file
system implementation. You can disable this feature with
`CloudStorageConfiguration.usePseudoDirectories()`.
system implementation. Using this feature with buckets or "directory" paths that do not exist
is not recommended, as at the time I/O is performed the failure may not be handled gracefully.
You can disable this feature with `CloudStorageConfiguration.usePseudoDirectories()`.

#### Complete source code

Expand Down
3 changes: 2 additions & 1 deletion ...oud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ public abstract class CloudStorageConfiguration {
* directories.
*
* <p>With this feature, if file "foo/bar.txt" exists then both "foo" and "foo/" will be treated
* as if they were existing directories.
* as if they were existing directories. On path construction no I/O will be performed, bucket and
* "directory" will treated as if they exist.
*/
public abstract boolean usePseudoDirectories();

Expand Down