API Reference noizu_core v1.0.28
modules
Modules
The Entity Reference Protocol (ERP) is a key component in the Noizu framework, used for handling references to entities in a uniform and flexible manner. The protocol defines a standard set of functions that must be implemented by any type that adheres to the protocol. This allows for a consistent way to interact with different types of entities (e.g., database records, structs, etc.) without having to know their specific implementation details.
The Noizu.ElixirCore.CallerEntity module provides a convenience structure for tracking API caller authentication levels. It supports the levels :internal, :restricted, :system, and :admin.
callingcontext
CallingContext
Context object used to track a caller's state and permissions along with unique request identifier for tracking requests as they travel through the layers in your application. Useful for log collation, permission checks, access auditing.
Provides guards for caller context and reference checks.
The Noizu.ElixirCore.PartialObjectCheck module provides a way to
define partial object constraints and perform assertions against
actual objects. It allows for specifying field presence, types, and values,
enabling granular control over object validation during testing.
The FieldConstraint struct represents a constraint on a specific field of a partial object. It includes information about whether the field is required, its type constraint, and its value constraint.
The TypeConstraint struct represents a type constraint for a field or the
entire partial object.
It holds the actual type constraint, which can be a basic type (e.g., :integer, :map),
a specific module, or a list of constraints. The TypeConstraint is used as part
of the PartialObjectCheck and FieldConstraint to define the expected type of a field or object.
The ValueConstraint struct represents a value constraint for a field.
It holds the actual value constraint, which can be a specific value,
a POC struct (for nested assertions), or a list of constraints.
The ValueConstraint is used as part of the FieldConstraint to define
the expected value of a field.
Noizu State Machine
The Noizu State Machine is a powerful tool for defining and managing state machines in Elixir applications. It provides a declarative way to define states, transitions, and behaviors using a DSL-like syntax.