package
1.2.0
Repository: https://github.com/open-policy-agent/opa.git
Documentation: pkg.go.dev

# Packages

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended.
Package inmem implements an in-memory version of the policy engine's storage layer.

# Functions

IsIndexingNotSupported is a stub for backwards-compatibility.
IsInvalidPatch returns true if this error is a InvalidPatchErr.
IsInvalidTransaction returns true if this error is a InvalidTransactionErr.
IsNotFound returns true if this error is a NotFoundErr.
IsWriteConflictError returns true if this error a WriteConflictErr.
MakeDir inserts an empty object at path.
MustParsePath returns a new Path for s.
NewContext returns a new context object.
NewPathForRef returns a new path for the given ref.
NewTransactionOrDie is a helper function to create a new transaction.
NonEmpty returns a function that tests if a path is non-empty.
ParsePath returns a new path for the given str.
ParsePathEscaped returns a new path for the given escaped str.
ReadOne is a convenience function to read a single value from the provided Store.
Txn is a convenience function that executes f inside a new transaction opened on the store.
WriteOne is a convenience function to write a single value to the provided Store.

# Constants

Patch supports add, remove, and replace operations.
InternalErr indicates an unknown, internal error has occurred.
InvalidPatchErr indicates an invalid patch/write was issued.
InvalidTransactionErr indicates an invalid operation was performed inside of the transaction.
NotFoundErr indicates the path used in the storage operation does not locate a document.
PolicyNotSupportedErr indicate the caller attempted to perform a policy management operation against a store that does not support them.
Patch supports add, remove, and replace operations.
Patch supports add, remove, and replace operations.
TriggersNotSupportedErr indicates the caller attempted to register a trigger against a store that does not support them.
WriteConflictErr indicates a write on the path enocuntered a conflicting value inside the transaction.
WritesNotSupportedErr indicate the caller attempted to perform a write against a store that does not support them.

# Variables

WriteParams specifies the TransactionParams for a write transaction.

# Type aliases

Context is a simple container for key/value pairs.
DataEvent describes a change to a base data document.
Error is the error type returned by the storage layer.
Iterator defines the interface that can be used to read files from a directory starting with files at the base of the directory, then sub-directories etc.
MakeDirer defines the interface a Store could realize to override the generic MakeDir functionality in storage.MakeDir.
PatchOp is the enumeration of supposed modifications.
Path refers to a document in storage.
Policy defines the interface for policy module storage.
PolicyEvent describes a change to a policy.
PolicyNotSupported provides a default implementation of the policy interface which may be used if the backend does not support policy storage.
Store defines the interface for the storage layer's backend.
Transaction defines the interface that identifies a consistent snapshot over the policy engine's storage layer.
TransactionParams describes a new transaction.
Trigger defines the interface that stores implement to register for change notifications when the store is changed.
TriggerConfig contains the trigger registration configuration.
TriggerEvent describes the changes that caused the trigger to be invoked.
TriggerHandle defines the interface that can be used to unregister triggers that have been registered on a Store.
TriggersNotSupported provides default implementations of the Trigger interface which may be used if the backend does not support triggers.
Update contains information about a file.
WritesNotSupported provides a default implementation of the write interface which may be used if the backend does not support writes.