studio-b12 / gowebdav

A golang WebDAV client library and command line tool.
BSD 3-Clause "New" or "Revised" License
309 stars 89 forks source link

Returns pointer to FileInfo from ReadDir #77

Open the-plate opened 1 year ago

the-plate commented 1 year ago

Returns pointer to os.FileInfo from ReadDir() - same as Stat does. This would than ensure compatibility of return types for Stat() and ReadDir(). Now are different.

ueffel commented 1 year ago

Since the methods of the interface implementation do not have a pointer receiver shouldn't Stat() return the struct itself instead of a pointer to the struct?

the-plate commented 1 year ago

What implementation do you mean exactly? I can see few having pointer receiver.

ueffel commented 1 year ago

https://github.com/studio-b12/gowebdav/blob/master/file.go I mean the implementation of os.FileInfo by gowebdav.File

the-plate commented 1 year ago

Ok I see. On one hand, I'm bit confused, the File struct in file.go does not implement the mentioned Stat() function. And on the other hand, it it possible to call value receiver function on a pointer value. The pointer in such case is automatically dereferenced. On top of that the File implements only, say, getters so the pointer receiver is not necessary and value receiver can be used.

the-plate commented 11 months ago

Hello, any comments on this topic ? Thanks!

the-plate commented 7 months ago

Hi @ueffel could you please comment on this? Thanks

ueffel commented 7 months ago

Ah, I got my trail of thought again:

Returning *gowebdav.File (pointer to struct) as os.FileInfo (interface) has an unnecessary level of indirection. Returning a struct (gowebdav.File) as interface (os.FileInfo) already makes a pointer out of it.

To align the return types of ReadDir and Stat, Stat should be changed, not ReadDir:

 // Stat returns the file stats for a specified path
 func (c *Client) Stat(path string) (os.FileInfo, error) {
-       var f *File
+       var f File
        parse := func(resp interface{}) error {
                r := resp.(*response)
-               if p := getProps(r, "200"); p != nil && f == nil {
-                       f = new(File)
+               if p := getProps(r, "200"); p != nil {
+                       f = File{}
                        f.name = p.Name
                        f.path = path
                        f.etag = p.ETag

@chripo thoughts?

chripo commented 7 months ago

I'm think @ueffel is right with the unnecessary level of indirection. Maybe we should refactor ReadDir to f = File{} too?

ueffel commented 7 months ago

Yeah, makes sense.

the-plate commented 7 months ago

Thanks for comments, will you make the changes?

chripo commented 7 months ago

@the-plate feel free to make changes!