cache

Documentation

Overview

Package cache implements the Fs cache

Index

• func Canonicalize(fsString string) string
• func Clear()
• func Get(ctx context.Context, fsString string) (f fs.Fs, err error)
• func GetFn(ctx context.Context, fsString string, ...) (f fs.Fs, err error)
• func Pin(f fs.Fs)
• func PinUntilFinalized(f fs.Fs, x interface{})
• func Put(fsString string, f fs.Fs)
• func Unpin(f fs.Fs)

Functions

func Canonicalize

func Canonicalize(fsString string) string

Canonicalize looks up fsString in the mapping from user supplied names to canonical names and return the canonical form

func Clear

func Clear()

Clear removes everything from the cache

func Get

func Get(ctx context.Context, fsString string) (f fs.Fs, err error)

Get gets an fs.Fs named fsString either from the cache or creates it afresh

func GetFn

func GetFn(ctx context.Context, fsString string, create func(ctx context.Context, fsString string) (fs.Fs, error)) (f fs.Fs, err error)

GetFn gets an fs.Fs named fsString either from the cache or creates it afresh with the create function

func Pin

func Pin(f fs.Fs)

Pin f into the cache until Unpin is called

func PinUntilFinalized

func PinUntilFinalized(f fs.Fs, x interface{})

PinUntilFinalized pins f into the cache until x is garbage collected

This calls runtime.SetFinalizer on x so it shouldn't have a finalizer already.

func Put

func Put(fsString string, f fs.Fs)

Put puts an fs.Fs named fsString into the cache

func Unpin

func Unpin(f fs.Fs)

Unpin f from the cache