package
1.1.3
Repository: https://github.com/permify/permify.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

CheckConcurrencyLimit - a functional option that sets the concurrency limit for the CheckEngine.
ContextToString function takes a Context object and converts it into a string.
ConvertToAnyPB is a function to convert various basic Go types into *anypb.Any.
GenerateKey function takes a PermissionCheckRequest and generates a unique key Key format: check|{tenant_id}|{schema_version}|{snap_token}|{context}|{entity:id#permission(optional_arguments)@subject:id#optional_relation}.
IsRelational determines if a given permission corresponds to a relational attribute in the provided entity definition.
No description provided by the author
NewBulkChecker creates a new BulkChecker instance.
NewBulkEntityPublisher creates a new BulkStreamer instance.
NewBulkSubjectPublisher creates a new BulkStreamer instance.
NewCheckEngine creates a new CheckEngine instance for performing permission checks.
NewEntityFilter creates a new EntityFilter engine.
NewExpandEngine - This function creates a new instance of ExpandEngine by taking a SchemaReader and a RelationshipReader as parameters and returning a pointer to the created instance.
No description provided by the author
NewMassSubjectFilter returns a new MassSubjectFilter.
No description provided by the author
No description provided by the author
SchemaBaseSubjectFilterConcurrencyLimit - a functional option that sets the concurrency limit for the LookupSubjectEngine.
SubjectPermissionConcurrencyLimit - a functional option that sets the concurrency limit for the SubjectPermissionEngine.

# Constants

No description provided by the author
No description provided by the author

# Structs

BulkChecker is a struct for checking permissions in bulk.
BulkCheckerRequest is a struct for a permission check request and the channel to send the result.
BulkEntityPublisher is a struct for streaming permission check results.
BulkSubjectPublisher is a struct for streaming permission check results.
CheckEngine is a core component responsible for performing permission checks.
CheckResponse - a struct that holds a PermissionCheckResponse and an error for a single check function.
EntityFilter is a struct that performs permission checks on a set of entities.
ExpandEngine - This comment is describing a type called ExpandEngine.
ExpandResponse is a struct that contains the response and error returned from the expand function in the ExpandEngine.
No description provided by the author
MassSubjectFilter is a struct that represents a filter for mass subjects.
No description provided by the author
SubjectFilterResponse -.
No description provided by the author
SubjectPermissionResponse - a struct that holds a SubjectPermissionResponse and an error for a single subject permission check result.
VisitsMap - a thread-safe map of ENR records.

# Type aliases

No description provided by the author
CheckCombiner is a type that represents a function which takes a context, a slice of CheckFunctions, and a limit.
CheckFunction is a type that represents a function that takes a context and returns a PermissionCheckResponse along with an error.
CheckOption - a functional option type for configuring the CheckEngine.
ExpandCombiner represents a function that combines the results of multiple ExpandFunction calls into a single ExpandResponse.
ExpandFunction represents a function that expands the schema and relationships of a request and sends the response through the provided channel.
No description provided by the author
SchemaBaseSubjectFilterOption - a functional option type for configuring the LookupSubjectEngine.
SubjectFilterCombiner defines the type for a function that takes a context, a slice of SubjectFilterFunctions, an integer as a limit and returns a pointer to a PermissionSubjectFilterResponse and an error.
SubjectFilterFunction defines the type for a function that takes a context and returns a pointer to a PermissionSubjectFilterResponse and an error.
SubjectPermissionOption - a functional option type for configuring the SubjectPermissionEngine.