Add writeToFile, writeToFileAsBytes, writeToFileAsString by jfaltis · Pull Request #85 · libsrcdev/shared-storage

jfaltis · 2022-07-14T20:16:42Z

This PR implements #61.

alexcmgit · 2022-07-15T14:12:59Z

android/src/main/kotlin/io/lakscastro/sharedstorage/storageaccessframework/DocumentFileApi.kt

+    result: MethodChannel.Result,
+    uri: String,
+    content: ByteArray,
+    mode: String,


Syntax error because of this comma:

Warning The feature "trailing commas" is only available since language version 1.4

alexcmgit · 2022-07-15T14:37:12Z

lib/src/saf/saf.dart

 }

+/// {@template sharedstorage.saf.writeToFile}
+/// Convenient method to write to a file using either String or raw bytes.


Suggested change

/// Convenient method to write to a file using either String or raw bytes.

/// Convenient method to write to a file using either [String] or raw bytes [Uint8List].

You can also apply this change for createFile function.

alexcmgit · 2022-07-15T14:39:07Z

lib/src/saf/saf.dart

+  }
+
+  final args = <String, dynamic>{
+    'uri': uri.toString(),


Suggested change

'uri': uri.toString(),

'uri': '$uri',

alexcmgit · 2022-07-15T14:39:36Z

lib/src/saf/saf.dart

+  var writeMode = 'wt';
+
+  if (mode == FileMode.append || mode == FileMode.writeOnlyAppend) {
+    writeMode = 'wa';
+  }


Suggested change

var writeMode = 'wt';

if (mode == FileMode.append || mode == FileMode.writeOnlyAppend) {

writeMode = 'wa';

}

final writeMode =

mode == FileMode.append || mode == FileMode.writeOnlyAppend ? 'wa' : 'wt';

alexcmgit · 2022-07-15T14:40:25Z

lib/src/saf/saf.dart

+
+/// {@template sharedstorage.saf.writeToFileAsString}
+/// Convenient method to write to a file.
+/// using `content` as String instead Uint8List.


Suggested change

/// using `content` as String instead Uint8List.

/// using `content` as [String] instead [Uint8List].

You can also apply this change for createFileAsString function.

alexcmgit · 2022-07-15T14:41:25Z

docs/Usage/Storage Access Framework.md

+
+Given the document uri, opens the file in the specified `mode` and writes the `bytes` to it.
+
+`mode` represents the mode in which the file will be opened for writing. Use `FileMode.write` for truncating and `FileMode.append` for appending to the file.


Suggested change

`mode` represents the mode in which the file will be opened for writing. Use `FileMode.write` for truncating and `FileMode.append` for appending to the file.

`mode` represents the mode in which the file will be opened for writing. Use `FileMode.write` for truncating (overwrite) and `FileMode.append` for appending to the file.

alexcmgit · 2022-07-15T14:42:26Z

docs/Usage/Storage Access Framework.md

+
+

Suggested change

alexcmgit · 2022-07-15T14:45:40Z

docs/Usage/Storage Access Framework.md

+);
+
+/// Write to a file using a [Uint8List] as file contents [bytes]
+final DocumentFile? createdFile = writeToFile(


Suggested change

final DocumentFile? createdFile = writeToFile(

final bool? success = writeToFile(

Guess this function returns a boolean representing the whether or not the operation was successful, if not let me know but I think it was just a typo.

alexcmgit · 2022-07-15T14:46:03Z

docs/Usage/Storage Access Framework.md

+);
+
+/// Append to a file using a [Uint8List] as file contents [bytes]
+final DocumentFile? createdFile = writeToFile(


Suggested change

final DocumentFile? createdFile = writeToFile(

final bool? success = writeToFile(

Guess this function returns a boolean representing the whether or not the operation was successful, if not let me know but I think it was just a typo.

alexcmgit · 2022-07-15T15:44:30Z

Great work, I tested and it works gracefully on Android 10+ (Tested on Samsung A30 and POCO M4 PRO).

I left some comments refering to small fixes related to the API documentation and code formatting. If you think something doesn't make sense just reply on it and lets discuss.

You can also pull this branch: lakscastro:feat/write-to-file-fixes, it contains the fix of all comments of this pull request.

Thanks for the hard work!

jfaltis · 2022-07-16T19:26:03Z

I am happy to hear that. I agree with all your changes!

alexcmgit · 2022-07-16T19:38:41Z

You did it! Happy to see your contribution here, I'll release on v0.5.0 today or tomorrow.

Any other requests or suggestions let me know!

(libsrcdev#61) add writeToFile, writeToFileAsBytes, writeToFileAsString

0648b7e

alexcmgit added the stage:dev This issue/feature doesn't seems to be stable enough to be considered released in the next version. label Jul 15, 2022

alexcmgit reviewed Jul 15, 2022

View reviewed changes

docs/Usage/Storage Access Framework.md Outdated

Comment on lines +578 to +579

Copy link

Member

alexcmgit Jul 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

alexcmgit reviewed Jul 15, 2022

View reviewed changes

(libsrcdev#85) Apply PR fixes

83fa900

alexcmgit pushed a commit that referenced this pull request Jul 15, 2022

(#85, #79, #61) Add more actions related to the writeToFile API

90ae52d

alexcmgit mentioned this pull request Jul 15, 2022

Add Erase file contents and Append file contents file options #94

Merged

alexcmgit pushed a commit that referenced this pull request Jul 15, 2022

(#85) Update plugin version to v0.5.0

74e8700

alexcmgit mentioned this pull request Jul 15, 2022

Update plugin version to v0.5.0 #98

Merged

alexcmgit approved these changes Jul 16, 2022

View reviewed changes

alexcmgit merged commit ace3244 into libsrcdev:master Jul 16, 2022

alexcmgit added stage:stable This issue/feature/resource seems to be stable enough to be considered released in the next version. and removed stage:dev This issue/feature doesn't seems to be stable enough to be considered released in the next version. labels Jul 16, 2022

This was referenced Jul 17, 2022

Write to a file #61

Closed

Add some way to update/overwrite file contents (e.g updateFile(...)) #79

Closed

Rollup v0.5.0 #100

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add writeToFile, writeToFileAsBytes, writeToFileAsString#85

Add writeToFile, writeToFileAsBytes, writeToFileAsString#85
alexcmgit merged 2 commits intolibsrcdev:masterfrom
jfaltis:feature/write-to-file

jfaltis commented Jul 14, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022 •

edited

Loading

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit Jul 15, 2022

Uh oh!

alexcmgit commented Jul 15, 2022

Uh oh!

jfaltis commented Jul 16, 2022

Uh oh!

alexcmgit commented Jul 16, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	/// Convenient method to write to a file using either String or raw bytes.
	/// Convenient method to write to a file using either [String] or raw bytes [Uint8List].

	/// using `content` as String instead Uint8List.
	/// using `content` as [String] instead [Uint8List].


		Given the document uri, opens the file in the specified `mode` and writes the `bytes` to it.

		`mode` represents the mode in which the file will be opened for writing. Use `FileMode.write` for truncating and `FileMode.append` for appending to the file.

	final DocumentFile? createdFile = writeToFile(
	final bool? success = writeToFile(

Uh oh!

Conversation

jfaltis commented Jul 14, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexcmgit Jul 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexcmgit commented Jul 15, 2022

Uh oh!

jfaltis commented Jul 16, 2022

Uh oh!

alexcmgit commented Jul 16, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alexcmgit Jul 15, 2022 •

edited

Loading