refactor(bindings/C): Alter naming convention for consistency

[xyjixyjixyji]

We remove blocking for consistency and will add async support in the future, where we will add async keyword to the API.

This PR also rename the opendal_reader_read() first argument from self to reader, since self is not a C convention.

[xyjixyjixyji]

Relate #3281

[xyjixyjixyji]

Oh, I notice this probably could break the swift, go and zig as well, @Xuanwo . Would you please take a look at that when you got time?

[jiaoew1991]

Oh, I notice this probably could break the swift, go and zig as well, @Xuanwo . Would you please take a look at that when you got time?

BTW c binding is used by other language bindings, does it ready to release? 🤔

[xyjixyjixyji]

BTW c binding is used by other language bindings, does it ready to release? 🤔

Hmm I think the major functionalities are already there, list, read, write. But there are still many other functionalities that we do not support.

There are a couple of things to consider

1. Does C binding always stay sync with other bindings? => For this question I think the answer is no. I would say other bindings that depend on C binding release with a certain version of C binding.
2. Do we need to align all functionalities that are implemented by other released bindings?

If the answer to the second question is yes, we may need to start figuring out what we are missing.
If the answer is no, i.e. we implement them in the future release, I think the C binding is ready for a release.

In any way this needs some discussions, but it is good to mention this issue up since we do need to make a release soon 🤣

[Xuanwo]

Does C binding always stay sync with other bindings?

For now, YES. For always, I don't know either. It depends on the future development of OpenDAL.

Pin exact tags of C binding for other binding is complex and makes the development work much harder.

[Xuanwo]

I'm willing to help address the issues for zig/go/swift. However, I would prefer to address the following comments first:

[Xuanwo]

This is a breaking change, it's better to record it in C binding's upgrade.md.

[xyjixyjixyji]

This is a breaking change, it's better to record it in C binding's upgrade.md.

I will address these issues later today. Thanks for the review.

[jiaoew1991]

Looking forward to the API stabilizing, so that I can continue with the integration work of Milvus. 😄

[Xuanwo]

Looking forward to the API stabilizing, so that I can continue with the integration work of Milvus. 😄

I believe this PR will address most of the API flavor issues.

[xyjixyjixyji]

This seems to be a PR that is related to many things, I will mark this as draft and make this ready for review after some polishments.

[Xuanwo]

cc @Ji-Xinyou, would you like to take a review? Thanks!

[Xuanwo]

cc @jiaoew1991, I have added an upgrade.md docs for C binding, would you like to take a look?

https://github.com/apache/incubator-opendal/blob/8396c4398af9281cbcbc4258e8773b05e85e75cf/bindings/c/upgrade.md

[xyjixyjixyji]

cc @jiaoew1991, I have added an upgrade.md docs for C binding, would you like to take a look?

https://github.com/apache/incubator-opendal/blob/8396c4398af9281cbcbc4258e8773b05e85e75cf/bindings/c/upgrade.md

Added commits look perfect to me.

[Xuanwo]

cc @Ji-Xinyou, do you think this PR is good to go?

[xyjixyjixyji]

cc @Ji-Xinyou, do you think this PR is good to go?

Yes, I think this PR is ready :)