Descriptions returns a formatted string of descriptions for each type.

DocumentPlugin adds a description and an optional configuration sanitiser function to the definition of a registered plugin.

GetDeprecatedPlugin returns a constructor for an old plugin if it exists.

New creates a cache type based on an cache configuration.

NewAWSDynamoDB creates a new DynamoDB cache type.

NewAWSS3 creates a new S3 cache type.

NewConfig returns a configuration struct fully populated with default values.

NewDynamoDB creates a new DynamoDB cache type.

NewDynamoDBConfig creates a MemoryConfig populated with default values.

NewFile creates a new File cache type.

NewFileConfig creates a FileConfig populated with default values.

NewMemcached returns a Memcached processor.

NewMemcachedConfig returns a MemcachedConfig with default values.

NewMemory creates a new Memory cache type.

NewMemoryConfig creates a MemoryConfig populated with default values.

NewMongoDBConfig returns a MongoDBConfig with default values.

NewMultilevel creates a new Multilevel cache type.

NewMultilevelConfig creates a MultilevelConfig populated with default values.

NewRedis returns a Redis processor.

NewRedisConfig returns a RedisConfig with default values.

NewRistretto creates a new Ristretto cache type.

NewRistrettoConfig creates a RistrettoConfig populated with default values.

NewS3 creates a new S3 cache type.

NewS3Config creates a S3Config populated with default values.

PluginCount returns the number of registered plugins.

PluginDescriptions generates and returns a markdown formatted document listing each registered plugin and an example configuration for it.

RegisterPlugin registers a plugin by a unique name so that it can be constructed similar to regular caches.

SanitiseConfig creates a sanitised version of a config.

WalkConstructors iterates each component constructor.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

String constants representing each cache type.

Constructors is a map of all cache types with their specs.

Config is the all encompassing configuration struct for all cache types.

DynamoDB is a DynamoDB based cache implementation.

DynamoDBConfig contains config fields for the DynamoDB cache type.

File is a file system based cache implementation.

FileConfig contains config fields for the File cache type.

Memcached is a cache that connects to memcached servers.

MemcachedConfig is a config struct for a memcached connection.

Memory is a memory based cache implementation.

MemoryConfig contains config fields for the Memory cache type.

MongoDBConfig is a config struct for a mongo connection.

Multilevel is a file system based cache implementation.

Redis is a cache that connects to redis servers.

RedisConfig is a config struct for a redis connection.

Ristretto is a memory based cache implementation.

RistrettoConfig contains config fields for the Ristretto cache type.

S3 is a file system based cache implementation.

S3Config contains config fields for the S3 cache type.

TypeSpec is a constructor and a usage description for each cache type.

ConstructorFunc is a func signature able to construct a cache.

MultilevelConfig contains config fields for the Multilevel cache type.

PluginConfigConstructor is a func that returns a pointer to a new and fully populated configuration struct for a plugin type.

PluginConfigSanitiser is a function that takes a configuration object for a plugin and returns a sanitised (minimal) version of it for printing in examples and plugin documentation.

PluginConstructor is a func that constructs a Benthos cache plugin.