func BytePtrFromString(sstring) (*byte,error)

func BytePtrToString(p *byte)string

func FreeLibrary(handleuintptr)error

func GetProcAddress(handleuintptr, namestring) (uintptr,error)

func LoadLibrary(pathstring) (uintptr,error)

type Capability struct {// contains filtered or unexported fields}

func (*Capability)Blocking¶

func (c *Capability) Blocking()bool

func (*Capability)Copy¶

func (c *Capability) Copy()bool

func (*Capability)CreateDir¶

func (c *Capability) CreateDir()bool

func (*Capability)Delete¶

func (c *Capability) Delete()bool

func (*Capability)List¶

func (c *Capability) List()bool

func (*Capability)ListWithLimit¶

func (c *Capability) ListWithLimit()bool

func (*Capability)ListWithRecursive¶

func (c *Capability) ListWithRecursive()bool

func (*Capability)ListWithStartAfter¶

func (c *Capability) ListWithStartAfter()bool

func (*Capability)Presign¶

func (c *Capability) Presign()bool

func (*Capability)PresignRead¶

func (c *Capability) PresignRead()bool

func (*Capability)PresignStat¶

func (c *Capability) PresignStat()bool

func (*Capability)PresignWrite¶

func (c *Capability) PresignWrite()bool

func (*Capability)Read¶

func (c *Capability) Read()bool

func (*Capability)ReadWithIfMatchNone¶

func (c *Capability) ReadWithIfMatchNone()bool

func (*Capability)ReadWithIfmatch¶

func (c *Capability) ReadWithIfmatch()bool

func (*Capability)ReadWithOverrideCacheControl¶

func (c *Capability) ReadWithOverrideCacheControl()bool

func (*Capability)ReadWithOverrideContentDisposition¶

func (c *Capability) ReadWithOverrideContentDisposition()bool

func (*Capability)ReadWithOverrideContentType¶

func (c *Capability) ReadWithOverrideContentType()bool

func (*Capability)Rename¶

func (c *Capability) Rename()bool

func (*Capability)Shared¶added inv0.1.5

func (c *Capability) Shared()bool

func (*Capability)Stat¶

func (c *Capability) Stat()bool

func (*Capability)StatWithIfNoneMatch¶

func (c *Capability) StatWithIfNoneMatch()bool

func (*Capability)StatWithIfmatch¶

func (c *Capability) StatWithIfmatch()bool

func (*Capability)Write¶

func (c *Capability) Write()bool

func (*Capability)WriteCanAppend¶

func (c *Capability) WriteCanAppend()bool

func (*Capability)WriteCanEmpty¶

func (c *Capability) WriteCanEmpty()bool

func (*Capability)WriteCanMulti¶

func (c *Capability) WriteCanMulti()bool

func (*Capability)WriteMultiMaxSize¶

func (c *Capability) WriteMultiMaxSize()uint

func (*Capability)WriteMultiMinSize¶

func (c *Capability) WriteMultiMinSize()uint

func (*Capability)WriteTotalMaxSize¶

func (c *Capability) WriteTotalMaxSize()uint

func (*Capability)WriteWithCacheControl¶

func (c *Capability) WriteWithCacheControl()bool

func (*Capability)WriteWithContentDisposition¶

func (c *Capability) WriteWithContentDisposition()bool

func (*Capability)WriteWithContentType¶

func (c *Capability) WriteWithContentType()bool

type Entry struct {// contains filtered or unexported fields}

func (*Entry)Name¶

func (e *Entry) Name()string

Name returns the last component of the entry's path.

func (*Entry)Path¶

func (e *Entry) Path()string

Path returns the full path of the entry.

type Error struct {// contains filtered or unexported fields}

func (*Error)Code¶

func (e *Error) Code()ErrorCode

func (*Error)Error¶

func (e *Error) Error()string

func (*Error)Message¶

func (e *Error) Message()string

type ErrorCodeint32

type FFI[Tany] struct {// contains filtered or unexported fields}

type Lister struct {// contains filtered or unexported fields}

func (*Lister)Close¶

func (l *Lister) Close()error

This method implements the io.Closer interface. It should be called whenthe Lister is no longer needed to ensure proper resource cleanup.

func (*Lister)Entry¶

func (l *Lister) Entry() *Entry

Entry returns the current Entry in the list.Returns nil if there are no more entries

func (*Lister)Error¶

func (l *Lister) Error()error

func (*Lister)Next¶

func (l *Lister) Next()bool

Next advances the Lister to the next entry in the list.

This method must be called before accessing the current entry. It preparesthe next entry for reading and indicates whether there are more entriesto process.

Returns¶

• bool: true if there is another entry to process, false if the end of the listhas been reached or an error occurred.

Usage¶

Next should be used in a loop condition to iterate through all entries:

for lister.Next() {entry := lister.Entry()// Process the entry}

Error Handling¶

If an error occurs during iteration, Next will return false. The errorcan then be retrieved by calling the Err method on the Lister.

Example¶

lister, err := op.List("path/to/list")if err != nil {log.Fatal(err)}for lister.Next() {entry := lister.Entry()fmt.Println(entry.Name())}

type Metadata struct {// contains filtered or unexported fields}

func (*Metadata)ContentLength¶

func (m *Metadata) ContentLength()uint64

ContentLength returns the size of the file in bytes.

For directories, this value may not be meaningful and could be zero.

func (*Metadata)IsDir¶

func (m *Metadata) IsDir()bool

IsDir returns true if the metadata represents a directory, false otherwise.

func (*Metadata)IsFile¶

func (m *Metadata) IsFile()bool

IsFile returns true if the metadata represents a file, false otherwise.

func (*Metadata)LastModified¶

func (m *Metadata) LastModified()time.Time

LastModified returns the time when the file or directory was last modified.

The returned time is in UTC.

type Operator struct {// contains filtered or unexported fields}

funcNewOperator¶

func NewOperator(schemeScheme, optsOperatorOptions) (op *Operator, errerror)

NewOperator creates and initializes a new Operator for the specified storage scheme.

Parameters:

• scheme: The storage scheme (e.g., "memory", "s3", "fs").
• options: Configuration options for the operator.

Returns:

• *Operator: A new Operator instance.
• error: An error if initialization fails, or nil if successful.

Note: Remember to call Close() on the returned Operator when it's no longer needed.

func (*Operator)Check¶

func (op *Operator) Check() (errerror)

Check verifies if the operator is functioning correctly.

This function performs a health check on the operator by sending a `list` requestto the root path. It returns any errors encountered during this process.

Returns¶

• error: An error if the check fails, or nil if the operator is working correctly.

Details¶

The check is performed by attempting to list the contents of the root directory.This operation tests the basic functionality of the operator, includingconnectivity and permissions.

Example¶

func exampleCheck(op *opendal.Operator) {err = op.Check()if err != nil {log.Printf("Operator check failed: %v", err)} else {log.Println("Operator is functioning correctly")}}

Note: This example assumes proper error handling and import statements.

func (*Operator)Close¶

func (op *Operator) Close()

Close releases all resources associated with the Operator.

It's important to call this method when the Operator is no longer neededto ensure proper cleanup of underlying resources.

Note: It's recommended to use defer op.Close() immediately after creating an Operator.

func (*Operator)Copy¶

func (op *Operator) Copy(src, deststring)error

Copy duplicates a file from the source path to the destination path.

This function copies the contents of the file at 'from' to a new or existing file at 'to'.

Parameters¶

• from: The source file path.
• to: The destination file path.

Returns¶

• error: An error if the copy operation fails, or nil if successful.

Behavior¶

• Both 'from' and 'to' must be file paths, not directories.
• If 'to' already exists, it will be overwritten.
• If 'from' and 'to' are identical, an 'IsSameFile' error will be returned.
• The copy operation is idempotent; repeated calls with the same parameters will yield the same result.

Example¶

func exampleCopy(op *operatorCopy) {err = op.Copy("path/from/file", "path/to/file")if err != nil {log.Printf("Copy operation failed: %v", err)} else {log.Println("File copied successfully")}}

Note: This example assumes proper error handling and import statements.

func (*Operator)CreateDir¶

func (op *Operator) CreateDir(pathstring)error

CreateDir creates a directory at the specified path.

CreateDir is a wrapper around the C-binding function `opendal_operator_create_dir`.It provides a way to create directories in the storage system.

Parameters¶

• path: The path where the directory should be created.

Returns¶

• error: An error if the directory creation fails, or nil if successful.

Notes¶

It is mandatory to include a trailing slash (/) in the path to indicatethat it is a directory. Failing to do so may result in a `CodeNotADirectory`error being returned by OpenDAL.

Behavior¶

• Creating a directory that already exists will succeed without error.
• Directory creation is always recursive, similar to the `mkdir -p` command.

Example¶

func exampleCreateDir(op *opendal.Operator) {err = op.CreateDir("test/")if err != nil {log.Fatal(err)}}

Note: This example assumes proper error handling and import statements.The trailing slash in "test/" is important to indicate it's a directory.

func (*Operator)Delete¶

func (op *Operator) Delete(pathstring)error

Delete removes the file or directory at the specified path.

Parameters¶

• path: The path of the file or directory to delete.

Returns¶

• error: An error if the deletion fails, or nil if successful.

Note¶

Use with caution as this operation is irreversible.

func (*Operator)Info¶

func (op *Operator) Info() *OperatorInfo

Info returns metadata about the Operator.

This method provides access to essential information about the Operator,including its storage scheme, root path, name, and capabilities.

Returns:

• *OperatorInfo: A pointer to an OperatorInfo struct containing the Operator's metadata.

func (*Operator)IsExist¶

func (op *Operator) IsExist(pathstring) (bool,error)

IsExist checks if a file or directory exists at the specified path.

This method provides a convenient way to determine the existence of a resourcewithout fetching its full metadata.

Parameters¶

• path: The path of the file or directory to check.

Returns¶

• bool: true if the resource exists, false otherwise.
• error: An error if the check operation fails, or nil if the check is successful.Note that a false return value with a nil error indicates that the resource does not exist.

Example¶

exists, err := op.IsExist("path/to/file")if err != nil {log.Fatalf("Error checking existence: %v", err)}if exists {fmt.Println("The file exists")} else {fmt.Println("The file does not exist")}

func (*Operator)List¶

func (op *Operator) List(pathstring) (*Lister,error)

List returns a Lister to iterate over entries that start with the given path in the parent directory.

This function creates a new Lister to enumerate entries in the specified path.

Parameters¶

• path: The starting path for listing entries.

Returns¶

• *Lister: A new Lister instance for iterating over entries.
• error: An error if the listing operation fails, or nil if successful.

Notes¶

1. List is a wrapper around the C-binding function `opendal_operator_list`. Recursive listing is not currently supported.
2. Returned entries do not include metadata information. Use op.Stat to fetch metadata for individual entries.

Example¶

func exampleList(op *opendal.Operator) {lister, err := op.List("test")if err != nil {log.Fatal(err)}for lister.Next() {entry := lister.Entry()meta, err := op.Stat(entry.Path())if err != nil {log.Printf("Error fetching metadata for %s: %v", entry.Path(), err)continue}fmt.Printf("Name: %s\n", entry.Name())fmt.Printf("Length: %d\n", meta.ContentLength())fmt.Printf("Last Modified: %s\n", meta.LastModified())fmt.Printf("Is Directory: %v, Is File: %v\n", meta.IsDir(), meta.IsFile())fmt.Println("---")}if err := lister.Err(); err != nil {log.Printf("Error during listing: %v", err)}}

Note: Always check lister.Err() after the loop to catch any errors thatoccurred during iteration.

func (*Operator)Read¶

func (op *Operator) Read(pathstring) ([]byte,error)

Read reads the entire contents of the file at the specified path into a byte slice.

This function is a wrapper around the C-binding function `opendal_operator_read`.

Parameters¶

• path: The path of the file to read.

Returns¶

• []byte: The contents of the file as a byte slice.
• error: An error if the read operation fails, or nil if successful.

Notes¶

• This implementation does not support the `read_with` functionality.
• Read allocates a new byte slice internally. For more precise memory controlor lazy reading, consider using the Reader() method instead.

Example¶

func exampleRead(op *opendal.Operator) {data, err := op.Read("test")if err != nil {log.Fatal(err)}fmt.Printf("Read: %s\n", data)}

Note: This example assumes proper error handling and import statements.

func (*Operator)Reader¶

func (op *Operator) Reader(pathstring) (*Reader,error)

Reader creates a new Reader for reading the contents of a file at the specified path.

This function is a wrapper around the C-binding function `opendal_operator_reader`.

Parameters¶

• path: The path of the file to read.

Returns¶

• *Reader: A reader for accessing the file's contents. It implements `io.ReadCloser`.
• error: An error if the reader creation fails, or nil if successful.

Notes¶

• This implementation does not support the `reader_with` functionality.
• The returned reader allows for more controlled and efficient reading of large files.

Example¶

func exampleReader(op *opendal.Operator) {r, err := op.Reader("path/to/file")if err != nil {log.Fatal(err)}defer r.Close()size := 1024 // Read 1KB at a timebuffer := make([]byte, size)for {n, err := r.Read(buffer)if err != nil {log.Fatal(err)}fmt.Printf("Read %d bytes: %s\n", n, buffer[:n])}}

Note: This example assumes proper error handling and import statements.

func (*Operator)Rename¶

func (op *Operator) Rename(src, deststring)error

Rename changes the name or location of a file from the source path to the destination path.

This function moves a file from 'from' to 'to', effectively renaming or relocating it.

Parameters¶

• from: The current file path.
• to: The new file path.

Returns¶

• error: An error if the rename operation fails, or nil if successful.

Behavior¶

• Both 'from' and 'to' must be file paths, not directories.
• If 'to' already exists, it will be overwritten.
• If 'from' and 'to' are identical, an 'IsSameFile' error will be returned.

Example¶

func exampleRename(op *opendal.Operator) {err = op.Rename("path/from/file", "path/to/file")if err != nil {log.Printf("Rename operation failed: %v", err)} else {log.Println("File renamed successfully")}}

Note: This example assumes proper error handling and import statements.

func (*Operator)Stat¶

func (op *Operator) Stat(pathstring) (*Metadata,error)

Stat retrieves metadata for the specified path.

This function is a wrapper around the C-binding function `opendal_operator_stat`.

Parameters¶

• path: The path of the file or directory to get metadata for.

Returns¶

• *Metadata: Metadata of the specified path.
• error: An error if the operation fails, or nil if successful.

Notes¶

• The current implementation does not support `stat_with` functionality.
• If the path does not exist, an error with code opendal.CodeNotFound will be returned.

Example¶

func exampleStat(op *opendal.Operator) {meta, err := op.Stat("/path/to/file")if err != nil {if e, ok := err.(*opendal.Error); ok && e.Code() == opendal.CodeNotFound {fmt.Println("File not found")return}log.Fatalf("Stat operation failed: %v", err)}fmt.Printf("File size: %d bytes\n", meta.ContentLength())fmt.Printf("Last modified: %v\n", meta.LastModified())}

Note: This example assumes proper error handling and import statements.

func (*Operator)Write¶

func (op *Operator) Write(pathstring, data []byte)error

Write writes the given bytes to the specified path.

Write is a wrapper around the C-binding function `opendal_operator_write`. It provides a simplifiedinterface for writing data to the storage. Currently, this implementation does not support the`Operator::write_with` method from the original Rust library, nor does it support streaming writesor multipart uploads.

Parameters¶

• path: The destination path where the bytes will be written.
• data: The byte slice containing the data to be written.

Returns¶

• error: An error if the write operation fails, or nil if successful.

Example¶

func exampleWrite(op *opendal.Operator) {err = op.Write("test", []byte("Hello opendal go binding!"))if err != nil {log.Fatal(err)}}

Note: This example assumes proper error handling and import statements.

func (*Operator)Writer¶added inv0.1.4

func (op *Operator) Writer(pathstring) (*Writer,error)

Writer returns a new Writer for the specified path.

Writer is a wrapper around the C-binding function `opendal_operator_writer`.It provides a way to obtain a writer for writing data to the storage system.

Parameters¶

• path: The destination path where data will be written.

Returns¶

• *Writer: A pointer to a Writer instance, or an error if the operation fails.

Example¶

func exampleWriter(op *opendal.Operator) {writer, err := op.Writer("test/")if err != nil {log.Fatal(err)}defer writer.Close()_, err = writer.Write([]byte("Hello opendal writer!"))if err != nil {log.Fatal(err)}}

Note: This example assumes proper error handling and import statements.

type OperatorInfo struct {// contains filtered or unexported fields}

func (*OperatorInfo)GetFullCapability¶

func (i *OperatorInfo) GetFullCapability() *Capability

func (*OperatorInfo)GetName¶

func (i *OperatorInfo) GetName()string

func (*OperatorInfo)GetNativeCapability¶

func (i *OperatorInfo) GetNativeCapability() *Capability

func (*OperatorInfo)GetRoot¶

func (i *OperatorInfo) GetRoot()string

func (*OperatorInfo)GetScheme¶

func (i *OperatorInfo) GetScheme()string

type OperatorOptions map[string]string

type Reader struct {// contains filtered or unexported fields}

func (*Reader)Close¶

func (r *Reader) Close()error

Close releases resources associated with the OperatorReader.

func (*Reader)Read¶

func (r *Reader) Read(buf []byte) (int,error)

Read reads data from the underlying storage into the provided buffer.

This method implements the io.Reader interface for OperatorReader.

Parameters¶

• buf: A pre-allocated byte slice where the read data will be stored.The length of buf determines the maximum number of bytes to read.

Returns¶

• int: The number of bytes read. Returns 0 if no data is available or the end of the file is reached.
• error: An error if the read operation fails, or nil if successful.Note that this method does not return io.EOF; it returns nil at the end of the file.

Notes¶

• The caller is responsible for pre-allocating the buffer and determining its size.

Example¶

reader, err := op.Reader("path/to/file")if err != nil {log.Fatal(err)}defer reader.Close()buf := make([]byte, 1024)for {n, err := reader.Read(buf)if err != nil {log.Fatal(err)}if n == 0 {break // End of file}// Process buf[:n]}

Note: Always check the number of bytes read (n) as it may be less than len(buf).

func (*Reader)Seek¶added inv0.1.11

func (r *Reader) Seek(offsetint64, whenceint) (int64,error)

Seek sets the offset for the next Read operation on the reader.

This method implements the io.Seeker interface for Reader.

Parameters¶

• offset: The offset from the origin (specified by whence).
• whence: The reference point for offset. Can be:
• io.SeekStart (0): Relative to the start of the file
• io.SeekCurrent (1): Relative to the current position
• io.SeekEnd (2): Relative to the end of the file

Returns¶

• int64: The new absolute position in the file after the seek operation.
• error: An error if the seek operation fails, or nil if successful.

Example¶

reader, err := op.Reader("path/to/file")if err != nil {log.Fatal(err)}defer reader.Close()// Seek to the middle of the filepos, err := reader.Seek(1000, io.SeekStart)if err != nil {log.Fatal(err)}fmt.Printf("New position: %d\n", pos)// Seek relative to current positionpos, err = reader.Seek(100, io.SeekCurrent)if err != nil {log.Fatal(err)}fmt.Printf("New position: %d\n", pos)

Note: The actual new position may differ from the requested positionif the underlying storage system has restrictions on seeking.

type Scheme interface {// Name returns the unique identifier of the scheme.Name()string// Path returns the filesystem path where the scheme's shared library (.so) is located.Path()string// LoadOnce initializes the scheme. It ensures that initialization occurs only once,// even if called multiple times. Subsequent calls after the first should be no-ops.//// Returns an error if initialization fails.LoadOnce()error}

type Writer struct {// contains filtered or unexported fields}

func (*Writer)Close¶added inv0.1.4

func (w *Writer) Close()error

Close finishes the write and releases the resources associated with the Writer.It is important to call Close after writing all the data to ensure that the data isproperly flushed and written to the storage. Otherwise, the data may be lost.

func (*Writer)Write¶added inv0.1.4

func (w *Writer) Write(p []byte) (nint, errerror)

Write writes the given bytes to the specified path.

Write is a wrapper around the C-binding function `opendal_operator_write`. It provides a simplifiedinterface for writing data to the storage. Write can be called multiple times to writeadditional data to the same path.

The maximum size of the data that can be written in a single call is 256KB.

Parameters¶

• path: The destination path where the bytes will be written.
• data: The byte slice containing the data to be written.

Returns¶

• error: An error if the write operation fails, or nil if successful.

Example¶

func exampleWrite(op *opendal.Operator) {err = op.Write("test", []byte("Hello opendal go binding!"))if err != nil {log.Fatal(err)}}

Note: This example assumes proper error handling and import statements.