transfers

Documentation

Overview

Package transfers provides in-memory file transfer orchestration for the Go SDK.

Index

• type GetFileInput
• type GetFileResult
  • func GetFile(ctx context.Context, c *server.Client, in GetFileInput) (*GetFileResult, error)
• type PutFileInput
• type PutFileResult
  • func PutFile(ctx context.Context, c *server.Client, in PutFileInput) (*PutFileResult, error)

Types

type GetFileInput

type GetFileInput struct {
	NamespaceID loonfs.NamespaceID
	Path        loonfs.AbsolutePath
	RevisionNo  *loonfs.RevisionNo
}

GetFileInput describes one current or retained file revision to read.

type GetFileResult

type GetFileResult struct {
	Bytes       []byte
	NamespaceID loonfs.NamespaceID
	Path        loonfs.AbsolutePath
	RevisionNo  loonfs.RevisionNo
	ContentRef  *loonfs.ContentRef
}

GetFileResult contains file bytes and the resolved revision facts.

func GetFile

func GetFile(ctx context.Context, c *server.Client, in GetFileInput) (*GetFileResult, error)

GetFile downloads one file revision into memory and verifies its content reference. Streaming and resume are follow-ups.

type PutFileInput

type PutFileInput struct {
	NamespaceID        loonfs.NamespaceID
	Path               loonfs.AbsolutePath
	Bytes              []byte
	Actor              *loonfs.ActorRef
	CommitID           loonfs.CommitID
	Message            *string
	Behavior           loonfs.DestinationBehavior
	ExpectedRevisionNo *loonfs.RevisionNo
}

PutFileInput describes one in-memory file write.

type PutFileResult

type PutFileResult struct {
	NamespaceID  loonfs.NamespaceID
	CommitID     loonfs.CommitID
	CommittedSeq loonfs.ChangeSeq
}

PutFileResult identifies the commit that made the new revision visible.

func PutFile

func PutFile(ctx context.Context, c *server.Client, in PutFileInput) (*PutFileResult, error)

PutFile uploads bytes, completes the upload, and commits the content to a path. Streaming and resume are follow-ups.