file

Documentation

Index

• Constants
• func DataDirPath(ctxt context.Context) string
• func DirExists(path string) bool
• func DotDirPath(ctxt context.Context) string
• func FileExists(path string) bool
• func GetDirs(root string) ([]string, error)
• func GrapplicationDatasetDirPath(ctxt context.Context, datasetName string) (string, error)
• func GrapplicationDgrzDirPath(ctxt context.Context) (string, error)
• func GrapplicationDirPath(ctxt context.Context) (string, error)
• func GrapplicationExist(ctxt context.Context, grappDirPath string) bool
• func GrapplicationObjectsDirPath(ctxt context.Context) (string, error)
• func GrapplicationRefsDirPath(ctxt context.Context) (string, error)
• func GrapplicationRefsHeadsDirPath(ctxt context.Context) (string, error)
• func IndexFilePath(ctxt context.Context) (string, error)
• func Touch(path string) error
• func WriteCommitHashToCurrentBranchHeadFile(ctxt context.Context, grappDirPath string, commitHash string) error
• func WriteHeadFile(ctxt context.Context, grappDirPath string, branchName string) error
• func WriteToFileAtomic(readerFunc func() (io.Reader, error), path string) (int64, error)

Constants

const DgrzDirName = ".dgrz"

BASE GRAP DIR FOR ALL STATE FILES

const DirLockFileName = ".__dirlock__"

const GrapplicationIdFileName = "ID"

const HeadFileName = "HEAD"

const HeadsDirName = "heads"

const IPFSAPIPortCounterFileName = ".ipfs-api-port-counter"

const IndexFileName = ".index"

const IndexFormatVersion = uint32(1)

const JSONLDDocumentName = ".document.jsonld"

const LOCK_FILE_SUFFIX = ".lock"

const MasterBranchName = "main"

const ObjectsDirName = "objects" // where file objects are cached

const RefsDirName = "refs"

const ResourceCacheSignature = "RESC"

Functions

func DataDirPath

func DataDirPath(ctxt context.Context) string

func DirExists

func DirExists(path string) bool

func DotDirPath

func DotDirPath(ctxt context.Context) string

func FileExists

func FileExists(path string) bool

func GetDirs

func GetDirs(root string) ([]string, error)

func GrapplicationDatasetDirPath

func GrapplicationDatasetDirPath(ctxt context.Context, datasetName string) (string, error)

func GrapplicationDgrzDirPath

func GrapplicationDgrzDirPath(ctxt context.Context) (string, error)

func GrapplicationDirPath

func GrapplicationDirPath(ctxt context.Context) (string, error)

func GrapplicationExist

func GrapplicationExist(ctxt context.Context, grappDirPath string) bool

func GrapplicationObjectsDirPath

func GrapplicationObjectsDirPath(ctxt context.Context) (string, error)

func GrapplicationRefsDirPath

func GrapplicationRefsDirPath(ctxt context.Context) (string, error)

func GrapplicationRefsHeadsDirPath

func GrapplicationRefsHeadsDirPath(ctxt context.Context) (string, error)

func IndexFilePath

func IndexFilePath(ctxt context.Context) (string, error)

func Touch

func Touch(path string) error

Creates an empty file at 'path' similar to Unix touch command

func WriteCommitHashToCurrentBranchHeadFile

func WriteCommitHashToCurrentBranchHeadFile(ctxt context.Context, grappDirPath string, commitHash string) error

func WriteHeadFile

func WriteHeadFile(ctxt context.Context, grappDirPath string, branchName string) error

func WriteToFileAtomic

func WriteToFileAtomic(readerFunc func() (io.Reader, error), path string) (int64, error)

Writes contents of Reader object to 'path' atomically i.e. no other writers can write at the same time. An attempt for other writers to do so simultaneously will result inn a 'TryAgain' error being returned RETURNS PathError or TryAgain error types