package
1.40.0
Repository: https://github.com/authzed/spicedb.git
Documentation: pkg.go.dev

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* COMPUTED_USERSET_ENTRYPOINT indicates an entrypoint where the subject's relation is "rewritten" via a `computed_userset` to the target permission's operation node.
* DIRECT_OPERATION_RESULT indicates that the entrypoint exists solely under zero or more union operations, making any reachable object also a *result* of the relation or permission.
* REACHABLE_CONDITIONAL_RESULT indicates that the entrypoint is under one or more intersections or exclusion operations, indicating that any reachable object *may* be a result, conditional on the parent non-union operation(s).
* RELATION_ENTRYPOINT indicates an entrypoint where the subject object can be directly found for a relationship.
* TUPLESET_TO_USERSET_ENTRYPOINT indicates an entrypoint where the subject's relation is walked via a `tupleset_to_userset` in the target permission's operation node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Enum value maps for CaveatOperation_Operation.
Enum value maps for CaveatOperation_Operation.
Enum value maps for ComputedUserset_Object.
Enum value maps for ComputedUserset_Object.
No description provided by the author
Enum value maps for FunctionedTupleToUserset_Function.
Enum value maps for FunctionedTupleToUserset_Function.
Enum value maps for ReachabilityEntrypoint_EntrypointResultStatus.
Enum value maps for ReachabilityEntrypoint_EntrypointResultStatus.
Enum value maps for ReachabilityEntrypoint_ReachabilityEntrypointKind.
Enum value maps for ReachabilityEntrypoint_ReachabilityEntrypointKind.
Enum value maps for RelationTupleUpdate_Operation.
Enum value maps for RelationTupleUpdate_Operation.
Enum value maps for SetOperationUserset_Operation.
Enum value maps for SetOperationUserset_Operation.

# Structs

* AllowedCaveat is an allowed caveat of a relation.
AllowedCaveatValidationError is the validation error returned by AllowedCaveat.Validate if the designated constraints aren't met.
* AllowedRelation is an allowed type of a relation when used as a subject.
No description provided by the author
No description provided by the author
AllowedRelation_PublicWildcardValidationError is the validation error returned by AllowedRelation_PublicWildcard.Validate if the designated constraints aren't met.
No description provided by the author
AllowedRelationValidationError is the validation error returned by AllowedRelation.Validate if the designated constraints aren't met.
No description provided by the author
CaveatDefinitionValidationError is the validation error returned by CaveatDefinition.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
No description provided by the author
CaveatExpressionValidationError is the validation error returned by CaveatExpression.Validate if the designated constraints aren't met.
No description provided by the author
CaveatOperationValidationError is the validation error returned by CaveatOperation.Validate if the designated constraints aren't met.
No description provided by the author
CaveatTypeReferenceValidationError is the validation error returned by CaveatTypeReference.Validate if the designated constraints aren't met.
No description provided by the author
ComputedUsersetValidationError is the validation error returned by ComputedUserset.Validate if the designated constraints aren't met.
* ContextualizedCaveat represents a reference to a caveat used to by caveated tuples.
ContextualizedCaveatValidationError is the validation error returned by ContextualizedCaveat.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
DirectSubjectsValidationError is the validation error returned by DirectSubjects.Validate if the designated constraints aren't met.
DirectSubjectValidationError is the validation error returned by DirectSubject.Validate if the designated constraints aren't met.
* ExpirationTrait is an expiration trait of a relation.
ExpirationTraitValidationError is the validation error returned by ExpirationTrait.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
FunctionedTupleToUserset_TuplesetValidationError is the validation error returned by FunctionedTupleToUserset_Tupleset.Validate if the designated constraints aren't met.
FunctionedTupleToUsersetValidationError is the validation error returned by FunctionedTupleToUserset.Validate if the designated constraints aren't met.
* Metadata is compiler metadata added to namespace definitions, such as doc comments and relation kinds.
MetadataValidationError is the validation error returned by Metadata.Validate if the designated constraints aren't met.
* NamespaceDefinition represents a single definition of an object type.
NamespaceDefinitionValidationError is the validation error returned by NamespaceDefinition.Validate if the designated constraints aren't met.
No description provided by the author
ObjectAndRelationValidationError is the validation error returned by ObjectAndRelation.Validate if the designated constraints aren't met.
* ReachabilityEntrypoint represents a single entrypoint for a specific subject type or subject relation into the reachability graph for a particular target relation.
* ReachabilityEntrypoints represents all the entrypoints for a specific subject type or subject relation into the reachability graph for a particular target relation.
ReachabilityEntrypointsValidationError is the validation error returned by ReachabilityEntrypoints.Validate if the designated constraints aren't met.
ReachabilityEntrypointValidationError is the validation error returned by ReachabilityEntrypoint.Validate if the designated constraints aren't met.
* ReachabilityGraph is a serialized form of a reachability graph, representing how a relation can be reached from one or more subject types.
ReachabilityGraphValidationError is the validation error returned by ReachabilityGraph.Validate if the designated constraints aren't met.
* Relation represents the definition of a relation or permission under a namespace.
No description provided by the author
RelationReferenceValidationError is the validation error returned by RelationReference.Validate if the designated constraints aren't met.
No description provided by the author
RelationshipFilterValidationError is the validation error returned by RelationshipFilter.Validate if the designated constraints aren't met.
No description provided by the author
RelationshipIntegrityValidationError is the validation error returned by RelationshipIntegrity.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RelationTupleTreeNodeValidationError is the validation error returned by RelationTupleTreeNode.Validate if the designated constraints aren't met.
No description provided by the author
RelationTupleUpdateValidationError is the validation error returned by RelationTupleUpdate.Validate if the designated constraints aren't met.
RelationTupleValidationError is the validation error returned by RelationTuple.Validate if the designated constraints aren't met.
RelationValidationError is the validation error returned by Relation.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SetOperation_Child_NilValidationError is the validation error returned by SetOperation_Child_Nil.Validate if the designated constraints aren't met.
No description provided by the author
SetOperation_Child_ThisValidationError is the validation error returned by SetOperation_Child_This.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SetOperation_ChildValidationError is the validation error returned by SetOperation_Child.Validate if the designated constraints aren't met.
No description provided by the author
SetOperationUsersetValidationError is the validation error returned by SetOperationUserset.Validate if the designated constraints aren't met.
SetOperationValidationError is the validation error returned by SetOperation.Validate if the designated constraints aren't met.
No description provided by the author
SourcePositionValidationError is the validation error returned by SourcePosition.Validate if the designated constraints aren't met.
SubjectFilter specifies a filter on the subject of a relationship.
No description provided by the author
SubjectFilter_RelationFilterValidationError is the validation error returned by SubjectFilter_RelationFilter.Validate if the designated constraints aren't met.
SubjectFilterValidationError is the validation error returned by SubjectFilter.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
TupleToUserset_TuplesetValidationError is the validation error returned by TupleToUserset_Tupleset.Validate if the designated constraints aren't met.
TupleToUsersetValidationError is the validation error returned by TupleToUserset.Validate if the designated constraints aren't met.
* TypeInformation defines the allowed types for a relation.
TypeInformationValidationError is the validation error returned by TypeInformation.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UsersetRewriteValidationError is the validation error returned by UsersetRewrite.Validate if the designated constraints aren't met.
No description provided by the author
ZookieValidationError is the validation error returned by Zookie.Validate if the designated constraints aren't met.

# Type aliases

AllowedCaveatMultiError is an error wrapping multiple validation errors returned by AllowedCaveat.ValidateAll() if the designated constraints aren't met.
AllowedRelation_PublicWildcardMultiError is an error wrapping multiple validation errors returned by AllowedRelation_PublicWildcard.ValidateAll() if the designated constraints aren't met.
AllowedRelationMultiError is an error wrapping multiple validation errors returned by AllowedRelation.ValidateAll() if the designated constraints aren't met.
CaveatDefinitionMultiError is an error wrapping multiple validation errors returned by CaveatDefinition.ValidateAll() if the designated constraints aren't met.
CaveatExpressionMultiError is an error wrapping multiple validation errors returned by CaveatExpression.ValidateAll() if the designated constraints aren't met.
No description provided by the author
CaveatOperationMultiError is an error wrapping multiple validation errors returned by CaveatOperation.ValidateAll() if the designated constraints aren't met.
CaveatTypeReferenceMultiError is an error wrapping multiple validation errors returned by CaveatTypeReference.ValidateAll() if the designated constraints aren't met.
No description provided by the author
ComputedUsersetMultiError is an error wrapping multiple validation errors returned by ComputedUserset.ValidateAll() if the designated constraints aren't met.
ContextualizedCaveatMultiError is an error wrapping multiple validation errors returned by ContextualizedCaveat.ValidateAll() if the designated constraints aren't met.
DirectSubjectMultiError is an error wrapping multiple validation errors returned by DirectSubject.ValidateAll() if the designated constraints aren't met.
DirectSubjectsMultiError is an error wrapping multiple validation errors returned by DirectSubjects.ValidateAll() if the designated constraints aren't met.
ExpirationTraitMultiError is an error wrapping multiple validation errors returned by ExpirationTrait.ValidateAll() if the designated constraints aren't met.
No description provided by the author
FunctionedTupleToUserset_TuplesetMultiError is an error wrapping multiple validation errors returned by FunctionedTupleToUserset_Tupleset.ValidateAll() if the designated constraints aren't met.
FunctionedTupleToUsersetMultiError is an error wrapping multiple validation errors returned by FunctionedTupleToUserset.ValidateAll() if the designated constraints aren't met.
MetadataMultiError is an error wrapping multiple validation errors returned by Metadata.ValidateAll() if the designated constraints aren't met.
NamespaceDefinitionMultiError is an error wrapping multiple validation errors returned by NamespaceDefinition.ValidateAll() if the designated constraints aren't met.
ObjectAndRelationMultiError is an error wrapping multiple validation errors returned by ObjectAndRelation.ValidateAll() if the designated constraints aren't met.
No description provided by the author
No description provided by the author
ReachabilityEntrypointMultiError is an error wrapping multiple validation errors returned by ReachabilityEntrypoint.ValidateAll() if the designated constraints aren't met.
ReachabilityEntrypointsMultiError is an error wrapping multiple validation errors returned by ReachabilityEntrypoints.ValidateAll() if the designated constraints aren't met.
ReachabilityGraphMultiError is an error wrapping multiple validation errors returned by ReachabilityGraph.ValidateAll() if the designated constraints aren't met.
RelationMultiError is an error wrapping multiple validation errors returned by Relation.ValidateAll() if the designated constraints aren't met.
RelationReferenceMultiError is an error wrapping multiple validation errors returned by RelationReference.ValidateAll() if the designated constraints aren't met.
RelationshipFilterMultiError is an error wrapping multiple validation errors returned by RelationshipFilter.ValidateAll() if the designated constraints aren't met.
RelationshipIntegrityMultiError is an error wrapping multiple validation errors returned by RelationshipIntegrity.ValidateAll() if the designated constraints aren't met.
RelationTupleMultiError is an error wrapping multiple validation errors returned by RelationTuple.ValidateAll() if the designated constraints aren't met.
RelationTupleTreeNodeMultiError is an error wrapping multiple validation errors returned by RelationTupleTreeNode.ValidateAll() if the designated constraints aren't met.
No description provided by the author
RelationTupleUpdateMultiError is an error wrapping multiple validation errors returned by RelationTupleUpdate.ValidateAll() if the designated constraints aren't met.
SetOperation_Child_NilMultiError is an error wrapping multiple validation errors returned by SetOperation_Child_Nil.ValidateAll() if the designated constraints aren't met.
SetOperation_Child_ThisMultiError is an error wrapping multiple validation errors returned by SetOperation_Child_This.ValidateAll() if the designated constraints aren't met.
SetOperation_ChildMultiError is an error wrapping multiple validation errors returned by SetOperation_Child.ValidateAll() if the designated constraints aren't met.
SetOperationMultiError is an error wrapping multiple validation errors returned by SetOperation.ValidateAll() if the designated constraints aren't met.
No description provided by the author
SetOperationUsersetMultiError is an error wrapping multiple validation errors returned by SetOperationUserset.ValidateAll() if the designated constraints aren't met.
SourcePositionMultiError is an error wrapping multiple validation errors returned by SourcePosition.ValidateAll() if the designated constraints aren't met.
SubjectFilter_RelationFilterMultiError is an error wrapping multiple validation errors returned by SubjectFilter_RelationFilter.ValidateAll() if the designated constraints aren't met.
SubjectFilterMultiError is an error wrapping multiple validation errors returned by SubjectFilter.ValidateAll() if the designated constraints aren't met.
TupleToUserset_TuplesetMultiError is an error wrapping multiple validation errors returned by TupleToUserset_Tupleset.ValidateAll() if the designated constraints aren't met.
TupleToUsersetMultiError is an error wrapping multiple validation errors returned by TupleToUserset.ValidateAll() if the designated constraints aren't met.
TypeInformationMultiError is an error wrapping multiple validation errors returned by TypeInformation.ValidateAll() if the designated constraints aren't met.
UsersetRewriteMultiError is an error wrapping multiple validation errors returned by UsersetRewrite.ValidateAll() if the designated constraints aren't met.
ZookieMultiError is an error wrapping multiple validation errors returned by Zookie.ValidateAll() if the designated constraints aren't met.