COSFILETRANSFER_VIRTUALFILESYSTEM(3erl)

✨ NAME ✨

CosFileTransfer_VirtualFileSystem — okay so this is the Erlang module that implements the OMG CosFileTransfer::VirtualFileSystem interface. It's chilling in the cosFileTransfer manual, section 3erl, and honestly? She's a whole vibe. 🦋

---

💖 DESCRIPTION 💖

Bestie, listen. If you want access to the record definitions for the structures in here, you gotta drop this line in:

-include_lib("cosFileTransfer/include/*.hrl").

That's it. That's the whole description. Iconic, minimal, no notes. 💅

---

🌈 EXPORTS 🌈

💫 '_get_file_system_type'(VFS) -> Return

Types, babes:

VFS = #objref
Return = 'FTP' | 'NATIVE'

This is a read only attribute and it represents the target object's associated file system. So like… whichever object you're pointing at, this tells you what kind of file system it's riding with — 'FTP' or 'NATIVE'. Periodt. ✨

---

🎀 '_get_supported_content_types'(VFS) -> Return

Types, my love:

VFS = #objref
Return =

Yeah, that Return = is genuinely just… empty in the original. Not me forgetting to type it, I promise — it's giving mysterious, it's giving suspense, it's giving nothing and everything at once. 💀

This is a read only attribute too, and it represents the target object's supported content types. That's the whole tea. 🍓

---

🧚 login(VFS, User, Password, Account) -> Return

Types, gorgeous:

VFS = #objref
User = Password = Account = string()
Return = {FileTransferSession, Directory} | {'EXCEPTION', E}
FileTransferSession = Directory = #objref

Okay so here's the moment. This operation creates a new instance of a FileTransferSession AND a Directory. And the latter — the Directory — represents the current working directory of the FileTransferSession that got returned to you. Like they come as a matching set, a little duo, a package deal. 🫶

And if things go sideways? You get {'EXCEPTION', E} instead. No cap. 😭

Also note: User, Password and Account are all string(), and the Return can also be that {'EXCEPTION', E} tuple, so like… handle it, bestie.

---

👑 bye bye 👑

That's the whole page, and honestly she ate. This was the Ericsson AB cosFileTransfer 5.2.2 situation — sending you all the slay, stay hydrated, and may your #objrefs always resolve. 🎀💜🌸