package
0.10.2
Repository: https://github.com/rite2nikhil/opa.git
Documentation: pkg.go.dev

# Packages

Package inmem implements an in-memory version of the policy engine's storage layer.

# Functions

IsIndexingNotSupported returns true if this error is a IndexingNotSupportedErr.
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.
NewPathForRef returns a new path for the given ref.
NewTransactionOrDie is a helper function to create a new transaction.
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.
IndexingNotSupportedErr indicate the caller attempted to perform an indexing operation against a store that does not support them.
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.

# Structs

DataEvent describes a change to a base data document.
Error is the error type returned by the storage layer.
IndexingNotSupported provides default implementations of the Indexing interface which may be used if the backend does not support indexing.
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.
TransactionParams describes a new transaction.
TriggerConfig contains the trigger registration configuration.
TriggerEvent describes the changes that caused the trigger to be invoked.
TriggersNotSupported provides default implementations of the Trigger interface which may be used if the backend does not support triggers.
WritesNotSupported provides a default implementation of the write interface which may be used if the backend does not support writes.

# Interfaces

Index defines the interface for searching a pre-built index.
Indexing defines the interface for building an index.
Policy defines the interface for policy module 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.
Trigger defines the interface that stores implement to register for change notifications when the store is changed.
TriggerHandle defines the interface that can be used to unregister triggers that have been registered on a Store.

# Type aliases

IndexIterator defines the interface for iterating over index results.
PatchOp is the enumeration of supposed modifications.
Path refers to a document in storage.