doc.md

datamove

import "github.com/intel/ixl-go/datamove"

Package datamove provides functions which leverages DSA hardware abilities to copy memory.

Index

• func Copy(dst []byte, src []byte) (ok bool)
• func Ready() bool
• type Context
  • func NewContext() *Context
  • func (c *Context) Copy(dest, src []byte) bool
  • func (c *Context) CopyCheckError(dest, src []byte) error

func Copy

func Copy(dst []byte, src []byte) (ok bool)

Copy copies the content of the source byte slice to the destination byte slice. It returns true if the copy operation is successful, and false otherwise.

func Ready

func Ready() bool

Ready returns true if the device is ready for use.

type Context

Context represents a context for a memory copy operation. It should be reset before each use. It must be created by NewContext.

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

func NewContext

func NewContext() *Context

NewContext creates a new context. The context should be reused if possible.

func (*Context) Copy

func (c *Context) Copy(dest, src []byte) bool

Copy copies the content of the source byte slice to the destination byte slice. It returns true if the copy operation is successful, and false otherwise.

func (*Context) CopyCheckError

func (c *Context) CopyCheckError(dest, src []byte) error

CopyCheckError copies the content of the source byte slice to the destination byte slice. It returns nil if the copy operation is successful, and error otherwise.

Generated by gomarkdoc